Skip to content

history

configure_history_parser

Add a history parser to an existing argparser.

Parameters:

Name Type Description Default
subparsers argparse._SubParsersAction

The parser object to be appended to.

 required
Source code in fastestimator\fastestimator\cli\history.py 
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
def configure_history_parser(subparsers: argparse._SubParsersAction) -> None:
    """Add a history parser to an existing argparser.

    Args:
        subparsers: The parser object to be appended to.
    """
    parser = subparsers.add_parser('history',
                                   description='View prior FE training histories',
                                   formatter_class=argparse.ArgumentDefaultsHelpFormatter,
                                   allow_abbrev=False)
    parser.add_argument('--limit', metavar='L', type=int, help="How many entries to return", default=15)
    parser.add_argument('--interactive',
                        dest='interactive',
                        help="Whether to run an interactive session which lets you look up detailed information",
                        action='store_true',
                        default=False)
    parser.add_argument('--args',
                        dest='include_args',
                        help="Whether to return a list of the args used to invoke the training",
                        action='store_true',
                        default=False)
    parser.add_argument('--errors',
                        dest='errors',
                        help="Whether to focus on failed trainings and include extra error information",
                        action='store_true',
                        default=False)
    parser.add_argument('--features',
                        dest='include_features',
                        help="Whether to return a list of the FE features used during each training",
                        action='store_true',
                        default=False)
    parser.add_argument('--datasets',
                        dest='include_datasets',
                        help="Whether to return a list of the datasets used during each training",
                        action='store_true',
                        default=False)
    parser.add_argument('--pipeline',
                        dest='include_pipeline',
                        help="Whether to return a list of the pipeline ops used during each training",
                        action='store_true',
                        default=False)
    parser.add_argument('--network',
                        dest='include_network',
                        help="Whether to return a list of the network ops used during each training",
                        action='store_true',
                        default=False)
    parser.add_argument('--traces',
                        dest='include_traces',
                        help="Whether to return a list of the traces used during each training",
                        action='store_true',
                        default=False)
    parser.add_argument('--pks',
                        dest='include_pk',
                        help="Whether to return the database primary keys of each entry",
                        action='store_true',
                        default=False)
    parser.add_argument('--csv',
                        dest='csv',
                        help='Print the response as a csv rather than a formatted table',
                        action='store_true',
                        default=False)
    sp = parser.add_subparsers()
    sql_parser = sp.add_parser('sql',
                               description='Perform a raw SQL query against the history database',
                               formatter_class=argparse.ArgumentDefaultsHelpFormatter,
                               allow_abbrev=False)
    sql_parser.add_argument('query',
                            metavar='<Query>',
                            type=str,
                            help="ex: fastestimator history sql 'SELECT * FROM history'")
    sql_parser.add_argument('--interactive',
                            dest='interactive',
                            help="Whether to run an interactive session which lets you look up detailed information",
                            action='store_true',
                            default=False)
    sql_parser.add_argument('--csv',
                            dest='csv',
                            help='Print the response as a csv rather than a formatted table',
                            action='store_true',
                            default=False)
    sql_parser.set_defaults(func=history_sql)
    clear_parser = sp.add_parser('clear',
                                 description='Clear out old history entries to save space',
                                 formatter_class=argparse.ArgumentDefaultsHelpFormatter,
                                 allow_abbrev=False)
    clear_parser.add_argument('retain',
                              metavar='N',
                              nargs='?',
                              type=int,
                              help="How many of the most recent entries to keep",
                              default=20)
    clear_parser.set_defaults(func=clear_history)
    settings_parser = sp.add_parser('settings',
                                    description="Modify history settings, such as how many logs to retain",
                                    formatter_class=argparse.ArgumentDefaultsHelpFormatter,
                                    allow_abbrev=False)
    settings_parser.add_argument('--keep',
                                 metavar='K',
                                 type=int,
                                 help="How many of the most recent history entries to keep")
    settings_parser.add_argument('--keep_logs',
                                 metavar='L',
                                 type=int,
                                 help="How many of the most recent log entries to keep")
    settings_parser.set_defaults(func=settings)
    parser.set_defaults(func=history_basic)

history_basic

A method to query FE history using CLI-provided arguments.

Parameters:

Name Type Description Default
args Dict[str, Any]

The arguments to be fed to the read_sql() method.

 required
unknown List[str]

Any cli arguments not matching known inputs for the read_sql() method.

 required

Raises:

Type Description
SystemExit

If unknown arguments were provided by the user.
Source code in fastestimator\fastestimator\cli\history.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
def history_basic(args: Dict[str, Any], unknown: List[str]) -> None:
    """A method to query FE history using CLI-provided arguments.

    Args:
        args: The arguments to be fed to the read_sql() method.
        unknown: Any cli arguments not matching known inputs for the read_sql() method.

    Raises:
        SystemExit: If `unknown` arguments were provided by the user.
    """
    if len(unknown) > 0:
        print("error: unrecognized arguments: ", str.join(", ", unknown))
        sys.exit(-1)
    with HistoryReader() as reader:
        reader.read_basic(limit=args['limit'],
                          interactive=args['interactive'],
                          include_args=args['include_args'],
                          errors=args['errors'],
                          include_pk=args['include_pk'],
                          include_traces=args['include_traces'],
                          include_features=args['include_features'],
                          include_datasets=args['include_datasets'],
                          include_pipeline=args['include_pipeline'],
                          include_network=args['include_network'],
                          as_csv=args['csv'])