Working with ML model templates

This section provides instructions on working with ML model templates.

The functionality is available after a license key is added.

You can create a template of an existing ML model to reuse its algorithm structure, set of elements, and training state at the time of the template creation. You can use a created template to add new ML models.

If the original ML model used as a template was created manually, you can add predictive elements, elliptic envelope-based elements, and/or elements based on diagnostic rules to the ML model created based on such template, as well as modify or delete them.

If the original ML model used to create a template was imported to Kaspersky MLAD, the set of elements of the ML model created based on such a template cannot be changed.

Before run inference on the ML model, train all of its predictive and elliptic envelope-based elements.

Creating a template based on an ML model

System administrators and users who have the Create model templates permission from the Manage ML models group of rights can create templates based on ML models. The functionality is available after a license key is added.

You can create an ML model template based on a previously added ML model. The created templates retain the algorithm structure, set of elements, tag composition, and the training state of the source ML model.

You can generate a template from an existing ML model if all predictive and elliptic envelope-based elements have been trained, and conditions have been set for all diagnostic rule-based elements.

To create a template based on an ML model:

1. In the main menu, select the Models section.
2. In the asset tree, next to the name of the ML model based on which you want to create a template, open the vertical menu and select Create template.

   A list of options appears on the right.

3. Specify the name of the template in the Name field.

   You can enter up to 100 characters.

   By default, a template is assigned a name in the format Template_<ML model name>_<date and time of template creation>.

4. To change the names of the template tags, in the Template tag name column specify the new names for the relevant tags.

   The template tags are automatically assigned the names of the tags employed in the ML model that was used to create the template. You can specify any other names for template tags. For example, you can use the functional descriptions of the tag roles. The names of the template tags do not have to match the names of the tags of the ML model that was used to create the template.

5. Click the Save button.

The new ML model template appears in the Templates group of the asset tree. The Templates group is created automatically and displayed as part of the selected section of the asset tree.

Editing an ML model template

You can edit the settings of a created ML model template.

System administrators and users who have the Edit model templates permission from the Manage ML models group of rights can edit ML model templates. The functionality is available after a license key is added.

To edit an ML model template:

1. In the main menu, select the Models section.
2. In the asset tree, select the template that you want to edit.

   A list of options appears on the right.

3. In the upper-right corner of the window, click the Edit button.
4. Adjust the settings of the ML model template, if needed. For a description of the settings, see instructions on creating an ML model template.
5. Click the Save button.

Creating an ML model based on a template

System administrators and users who have the Create models permission from the Manage ML models group of rights can create ML models based on templates. The functionality is available after a license key is added.

You can create a new ML model based on available templates. When creating an ML model, you can specify the IDs of tags that should be used in the new ML model.

To create an ML model based on a template:

1. In the main menu, select the Models section.
2. In the asset tree, next to the name of the template that you want to use to create an ML model, open the vertical menu and select Create model.

   The Creating a model pane opens on the right.

3. Enter a name for the new ML model in the Model name field.

   The ML model name must not be longer than 100 characters.

4. In the Model tag name column, for each template tag, in the asset tree select the tag that will be used by an ML model that is created from the template.
5. Click the Save button.

The new ML model displays in the Models group of the asset tree. The Models group is created automatically and displayed as part of the selected section of the asset tree. If the ML model contains predictive elements, elliptic envelope-based elements, and/or diagnostic rule-based elements, the Models group will display the Predictive elements, Elliptic envelopes and/or Rules subgroups, respectively.

The state of the created ML model will match the training state of the source ML model when the template was created.

Removing an ML model template

System administrators and users who have the Delete model templates permission from the Manage ML models group of rights can remove ML model templates. The functionality is available after a license key is added.

You can remove an ML model template from Kaspersky MLAD. Deleting a template does not remove ML models based on this template.

To remove an ML model template:

1. In the main menu, select the Models section.
2. In the asset tree, select the ML model template that you want to delete.

   A list of options appears on the right.

3. In the upper-right corner of the window, click .
4. Confirm deletion of the ML model template.

The selected ML model template will be removed from Kaspersky MLAD.