Working with markups

This section provides information on working with markups.

The functionality is available after a license key is added.

In the Models section, you can create, modify, and delete markups. If required, you can view the graph to see the data time intervals that the ML model will use for training and/or inference.

Markups are used as training or inference indicators to point to data time intervals that the ML model can use for training or inference. When creating or changing the parameters of an ML model, you can generate an

inference indicator

A set of criteria used to determine the data time intervals on which the ML model performs the inference.

learning indicator

A set of criteria used to determine the data time intervals on which the ML model performs the training.

Creating markup

You can use markup to generate learning indicators or inference of the ML model.

The functionality is available after a license key is added.

To create markup:

1. In the main menu, select the Models section.
2. In the asset tree, next to the name of the asset for which you want to create a markup, open the vertical menu and select Create markup.

   A list of options appears on the right.

3. Specify the name of the markup in the Name field.
4. Enter a description for the markup in the Description field.
5. In the Grid step (sec) field, specify a UTG period for markup in seconds expressed as a decimal.
6. In the Markup color field, select a color that will be used to highlight data intervals selected by the markup.
7. If necessary, turn on the Treat inconclusive result as positive toggle switch.

   If Kaspersky MLAD cannot unequivocally evaluate the fulfillment of criteria specified in the Time filter and Tag conditions settings blocks, for example, due to the absence of observations for tags, the application will consider specified criteria to be fulfilled when this option is enabled.

8. In the Time filter settings block, do one the following:
   • To add an interval, click Add interval and select one of the following time interval types from the Interval type drop-down list:
     • Fixed. If you select this type of interval, specify the days of the week and the time interval during which the input data must be validated according to the specified criteria.

     • Recurrent. If you select this type of interval, specify the years, dates, days of the week, and daily time interval for periodically validating input data according to the specified criteria.
   • To delete an interval, click to the right of the interval.

   You can add one or more time intervals.

9. To add tag behavior criteria, do the following:
   1. In the Tag conditions settings block, click the Condition button.

   2. In the Tag drop-down list, select the tag for which to add a tag behavior criterion.

      If you need to check the behavior directly opposite of the selected behavior criterion from the condition block, click the NOT button on the left of the selected tag. The NOT caption in the button will be highlighted in bold.

      For example, click the NOT button if you need to add a condition that contains no steps with the specified settings.

   3. In the Behavior drop-down list, select one of the following tag behaviors that must be tracked:
      • Over: the tag value exceeds the specified threshold.
      • Below: the tag value falls below the specified threshold.
      • Rising: the trendline of tag values is increasing.
      • Falling: the trendline of tag values is decreasing.
      • Level: there are no pronounced changes in the trendline of tag values.
      • Step change: the trendline of the selected tag is displaying abrupt upward or downward shifts.
      • Flat: the selected tag is transmitting the same value.
      • Spread: abrupt changes in the spread of values are being observed around the trendline of the selected tag.
   4. In the Window field, specify an interval for analyzing the behavior of tags in the UTG steps.
   5. Depending on the value selected for Behavior, do one of the following:
      • If you selected Over or Below, specify a tag threshold value in the Threshold field and specify the minimum number of times the threshold value can be breached within a window in the Minimum violations field.
      • If you selected Rising, Falling, or Level, use the Threshold slope field to specify the trend slope percentage value that must be exceeded for the trend to be considered as growing or falling, and specify the time interval between adjacent trend estimates in the Evaluation period field.

        By default, the Threshold slope setting is not defined. If the setting is not defined, Kaspersky MLAD will determine the trend direction automatically.

        By default, the Evaluation period setting has a value of 1. With this value, the trend is estimated at each UTG node.

      • If you selected Spread, use the Minimum change field to specify the minimum value by which the tag value spread around the trendline can change, and select one of the following spread change directions in the Direction drop-down list: Any, Flare, or Shrink.

        By default, the Minimum change setting is not defined. If the setting is not defined, Kaspersky MLAD will determine it automatically.

        The tag behavior criterion is met when the tag spread around the trendline increases and/or decreases.

      • If you selected Step change, use the Minimum change field to specify the minimum shift value for the tag trendline, and select one of the following tag value change directions from the Direction drop-down list: Any, Up or Down.

        By default, the Minimum change setting is not defined. If the setting is not defined, Kaspersky MLAD will determine it automatically.

      • If you selected Flat, use the Value field to specify the value that the tag should transmit, and specify the maximum tag value spread in the Spread field.

        The Spread parameter is set to zero by default. With this value, any repeating tag value triggers the criterion.

   6. To add a tag behavior criterion to a condition block, click the plus sign at the bottom of the condition block and repeat steps 9b through 9e.
   7. If the block contains more than one tag behavior criterion, select one of the following logical operators between the criterion rows by clicking logical operator button:
      • AND if you require all of the block criteria to be fulfilled at the same time.
      • OR if at least one of the block criteria must be fulfilled.
   8. To delete a tag behavior criterion from a condition block, click in the row that contains the criterion.

10. If you need to check whether the fulfillment of a pre-condition triggered the fulfillment of a post-condition, do the following:
    1. Add one of the following temporal operators:
       • Wait if you need to generate the result of the criteria check in the last node of the maximum waiting interval.
       • If ahead if you need to generate the result of the criteria check at the time of a pre-condition check.

       The Wait and If ahead buttons are available after adding at least one condition.

       Markup with an If ahead temporal operator can be used in learning indicators only.

    2. In the Recess (steps) field, specify the following time intervals:
       • from is the interval between the pre-condition check node and the UTG node where the post-condition check will start (minimum waiting interval).
       • to is the interval between the pre-condition check node and the UTG node where the post-condition check will finish (maximum waiting interval).

       The post-condition is checked in the UTG nodes between the minimum and maximum waiting intervals.

    3. In the Check drop-down list, select one of the following group operators:
       • If you require fulfillment of tag behavior criteria from the post-conditions in all UTG nodes between the minimum and maximum waiting intervals, select the All steps group operator.
       • To require fulfillment of tag behavior criteria from the post-conditions in at least one UTG node between the minimum and maximum waiting intervals, select the Any step group operator.

       If the Wait temporal operator is added, the criteria check result is determined in the last node of the maximum waiting interval. If more than one condition check is performed using the Wait temporal operator, the result of the previous temporal condition check is the precondition for each subsequent check of the Wait temporal condition.

       If the If ahead temporal operator is added, the criteria check result is generated at the time of the precondition check.

11. Select one of the following logical operators between markup blocks by clicking the logical operator button:
    • AND if you require the criteria of both condition blocks to be fulfilled.
    • OR if the criterion of at least one of the condition blocks must be fulfilled.
12. In the upper-right corner of the window, click the Save button.

The new markup will be displayed in the Markups group of the asset tree. The Markups group is created automatically and displayed as part of the selected section of the asset tree.

Viewing the markup chart

After creating markup, you can view data time intervals selected by the markup on the graph.

The functionality is available after a license key is added.

To view the markup chart:

1. In the main menu, select the Models section.
2. In the asset tree, select the markup whose chart you want to view.

   A list of options appears on the right.

3. Click the On graph button.

   A pane with the markup chart appears on the right.

4. Select the relevant preset from the Preset drop-down list.
5. If necessary, in the Markups field, select the markups for displaying data intervals.
6. If you need to select a date and time for displaying the data, do one of the following:
   • In the Graph center field, select the date and time for which you want to display data in the chart.

     The vertical black dotted line will indicate the selected date and time (in the center of the chart).

   • Click to the left of the time axis, and select the point on the time axis.

     The selected point will become the new center of the graph. The vertical black dashed line will indicate the new date and time.

7. If you need to select a time interval for displaying data on the chart, do one of the following:
   • If you need to display data for a fixed time interval, select the relevant time interval from the Scale drop-down list. The following time intervals are available by default:
     • 1, 5, 10, 15, and 30 minutes
     • 1, 3, 6, and 12 hours
     • 1, 2, 15, and 30 days
     • 3 and 6 months
     • 1, 2, and 3 years

     If necessary, the system administrator can create, edit, or delete time intervals.

   • To display data for a custom time interval, click the button icon to the left of the time axis, select the required interval on the time axis, and click the Apply button. If you need to change the scale again, repeat this step.

The chart will show the data intervals in the colors specified for the selected markups.

Copying a markup

You can create a markup by copying a previously created one. Copying will create a markup whose settings match those of the original at the time of copying.

The functionality is available after a license key is added.

To copy a markup:

1. In the main menu, select the Models section.
2. In the asset tree, next to the name of markup that you want to copy, open the vertical menu and select Copy markup.

   The Copy markup pane appears on the right.

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

   By default, the markup is assigned a name in the following format: <name of the original markup>_Cloned_<date and time of cloning>.

4. In the Asset drop-down list, select the asset to which you want to assign the markup.
5. Click the Save button.

The new markup will be displayed in the Markups group of the asset tree. The Markups group is created automatically and displayed as part of the selected section of the asset tree.

Modifying the markup

You can edit the markup settings.

Markup settings cannot be edited for imported ML models and ML models that were created by cloning imported ML models or based on a template of imported ML models.

The functionality is available after a license key is added.

To edit markup:

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

   A list of options appears on the right.

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

Removing markup

You can delete markup if it is not used for training or inference of any ML model.

The functionality is available after a license key is added.

To delete markup:

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

   A list of options appears on the right.

3. In the upper-right corner of the window, click .
4. In the window that opens, confirm the deletion of the markup.