Model
Model
Model page can be viewed by clicking on the name of specific model. Here you can find all versions of the model, switch best model, train a new one, retrain and delete model versions.
Columns Description
- Version - the Model version.
- Description - the short description of the Model.
- Status - the Model status.
- Created By - the name of the user who created Model.
- Creation Date – date of creation of the Model
Control icons
- Refresh - to pull the last updates from the server.
- Activate - to switch the best model. Best model is the one that will be used on apply by default.
- Training Config - to open a window with a set of configurations used for training the model. Required Permission: MlModel-READ. See Role Permissions.
- Export ML Model Package - to export the model as a single package. Required Permission: MlModel-READ. See Role Permissions.
- Open model log - to view the model's training log. Required Permission: MlModel-READ. See Role Permissions.
- Delete - to delete the Model. Required Permission: MlModel-DELETE. See Role Permissions.
Table Settings
Table settings allow you to manage the table view. Click the icon to start working with the table settings. The table settings can be managed with the following buttons:
- Advanced filter - to switch the advanced filters for the columns.
- Columns Display - to select the columns that will be displayed in the table.
- Apply - to apply the changes made to the table settings.
- Сancel - to cancel the last actions with the table settings.
Filter by text
Filtering allows you to search the Model by Name, Description, Version columns.
Advanced filters by columns
Advanced Filter allows you to extract a list from a table with predefined criteria. Click the icon to start working with the advanced filter. The advanced filters can be managed with the following buttons:
- Clear filter - to reset all the proposed advanced filter criteria for the column.
- Сancel - to cancel the last actions with the proposed criteria for the column.
- Apply - to filter the table according to the proposed criteria for the column.
Sorting
Ascending/descending sorting is allowed for Name, Version columns.
Grouping
Grouping is allowed for the Status column.
Model Resources
You can also view and download model resources, such as model report, by clicking on model’s version:
- model_report.json - JSON formatted result of model version execution for test set.
- model_report.xlsx - XLSX formatted result of model version execution for test set. For more information, please follow Analysis of result.
- train_config.json - training configuration used for model version training. For more information, please follow Model Training Configuration File for Classification Models and Model Training Configuration File for Information. Extraction Models
- train_data.json - data used to train model version in JSON format.
- train_result.json - model version training result in JSON format.
Retrain Model
The system allows the retraining of existing models. Settings for model retraining are uploaded automatically from the previous iteration as well as Document Set, Name, and Description. The last number of model version is incremented by one.
To retrain a model, you need to:
- Click the Training Config button
- Click the RETRAIN button
- Adjust or use existing attributes
- Click TRAIN button
To retrain a model, you need to be granted MlModel-READ and MlModel-CREATE permissions. See Role Permissions.
Model Log
The system allows viewing the training log for ML models created in the system. To view the log, you need to click the Open model log icon for the specific model.
Model logs page is opened:
Control icons
- Refresh - to pull the latest logs from the server.
- Autorefresh toggle - to turn on/off an automatic refresh of logs.
Search by text and Query search
You can search for a particular log by its text. The logs found are highlighted in yellow. Refer to the following article for more information on using the Search field to search through logs by query: Logs Search syntax.
Filter by severity
Filtering allows you to choose the level of severity of the displayed logs from the dropdown menu. The available options are as follows:
View columns
You can add or remove the columns timestamp/severity/logger from the Model log view.
Sort by timestamp
Ascending/descending logs sorting by the timestamp is allowed:
Not Full Logs
Not Full Logs indicator appears at the bottom right corner when the log becomes too long for one page:
Full Screen
To view more log records simultaneously enter the full screen mode via clicking the corresponding button:
Copy
To copy the displayed logs only use Copy button:
Download Full Logs
To download full logs (a .txt file with logs) use Download Full Logs button:
Model Status Lifecycle
- Ready - the model is ready to be used for data processing.
- Submitted for training - the training process is in the progress.
- Training failed - the training process failed, the model is not operational.