Skip to content

Commit b0dda3c

Browse files
Adapted new style; small rewrites
1 parent 8ee083c commit b0dda3c

File tree

8 files changed

+42
-34
lines changed

8 files changed

+42
-34
lines changed

md-docs/stylesheets/extra.css

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,8 @@
3030
background-color: rgb(43, 155, 70);
3131
-webkit-mask-image: var(--md-admonition-icon--code-block);
3232
mask-image: var(--md-admonition-icon--code-block);
33+
}
34+
35+
.nice-list ul{
36+
list-style-type: circle;
3337
}

md-docs/user_guide/data.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Available categories are:
1919
The [Data Schema] created for the [Task] contains a list of Column objects, each of which has a _Role_.
2020
Naturally, there is a relationship between the Column's Role and the Data Category.
2121
In fact, each Data Category comprises a set of Column objects with certain Roles.
22-
So that, when you upload samples belonging to a Data Category, they must contains all the Columns objects declared on the Data Schema to be considered valid.
22+
When you upload samples belonging to a Data Category, they must contain all the Columns objects declared on the Data Schema to be considered valid.
2323

2424
The following table shows these relationships:
2525

@@ -130,7 +130,7 @@ For RAG Tasks, reference data can be used to indicate the type of data expected
130130
You can set reference data as follow:
131131

132132
``` py
133-
job_id = job_id = client.set_model_reference(
133+
job_id = client.set_model_reference(
134134
model_id=model_id,
135135
from_timestamp=from_timestamp,
136136
to_timestamp=to_timestamp,

md-docs/user_guide/modules/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ Modules can be always active or on-demand: Monitoring module and Drift Explainab
1313

1414
Data drift detection over data.
1515

16-
[:octicons-arrow-right-24: More info](user_guide/company.md)
16+
[:octicons-arrow-right-24: More info](../monitoring/index.md)
1717

1818
- :material-compare:{ .lg .middle } **Drift Explainability**
1919

2020
---
2121

2222
Understand the nature of detected drift.
2323

24-
[:octicons-arrow-right-24: More info](user_guide/modules/index.md)
24+
[:octicons-arrow-right-24: More info](../monitoring/drift_explainability.md)
2525

2626
- :material-speedometer:{ .lg .middle } **Retraining**
2727

md-docs/user_guide/monitoring/detection_event.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,17 @@ A Detection Event is raised by the ML cube Platform when a significant change is
55
An event is characterized by the following attributes:
66

77
- `Event Type`: the type of the event. It's possible values are:
8-
- `Warning On`: the monitoring entity is experiencing slight changes that might lead to a drift.
9-
- `Warning Off`: the monitoring entity has returned to the reference distribution.
10-
- `Drift On`: the monitoring entity has drifted from the reference distribution.
11-
- `Drift Off`: the monitoring entity has returned to the reference distribution.
8+
<div class="nice-list">
9+
<ul>
10+
<li> `Warning On`: the monitoring entity is experiencing slight changes that might lead to a drift.</li>
11+
<li> `Warning Off`: the monitoring entity has returned to the reference distribution. </li>
12+
<li> `Drift On`: the monitoring entity has drifted from the reference distribution.</li>
13+
<li> `Drift Off`: the monitoring entity has returned to the reference distribution.</li>
14+
</ul>
15+
</div>
1216
- `Severity`: the severity of the event. It's provided only for drift events and it can be `Low`, `Medium`, or `High`.
13-
- `Monitoring Target`: the Monitoring Target being monitored (see the [Monitoring] page for more details on what a Monitoring Target is).
14-
- `Monitoring Metric`: the Monitoring Metric being monitored (see the [Monitoring] page for more details on what a Monitoring Metric is).
17+
- `Monitoring Target`: the [Monitoring Target](index.md#monitoring-metrics) being monitored.
18+
- `Monitoring Metric`: the [Monitoring Metric](index.md#monitoring-metrics) being monitored.
1519
- `Model Name`: the name of the model that raised the event. It's present only if the event is related to a model.
1620
- `Model Version`: the version of the model that raised the event. It's present only if the event is related to a model.
1721
- `Insert datetime`: the time when the event was raised.

md-docs/user_guide/monitoring/detection_event_rules.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ Rules are specific to a task and are characterized by the following attributes:
99

1010
- `Name`: a descriptive label of the rule.
1111
- `Detection Event Type`: the type of event that triggers the rule.
12-
- `Severity`: the severity of the event that triggers the rule. If not specified, the rule will be triggered by events of any severity.
13-
- `Monitoring Target`: the monitoring target whose event should trigger the rule.
14-
- `Monitoring Metric`: the monitoring metric whose event should trigger the rule.
12+
- `Severity`: the severity of the event that triggers the rule. It is only applicable to drift events. If not specified, the rule will be triggered by drift events of any severity.
13+
- `Monitoring Target`: the [Monitoring Target](index.md#monitoring-targets) whose event should trigger the rule.
14+
- `Monitoring Metric`: the [Monitoring Metric](index.md#monitoring-metrics) whose event should trigger the rule.
1515
- `Model name`: the name of the model to which the rule applies. This is only required when the monitoring target is related to a model
1616
(such as `ERROR` or `PREDICTION`).
1717
- `Actions`: A list of actions to be executed sequentially when the rule is triggered.

md-docs/user_guide/monitoring/drift_explainability.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ensuring the model continues to function as expected. However, monitoring only i
66
In order to make the right decisions, you need to understand what were the main factors that led to the drift in the first place, so that
77
the correct actions can be taken to mitigate it.
88

9-
The ML cube Platform supports this process by offering what we refer to as "**Drift Explainability Reports**",
9+
The ML cube Platform supports this process by offering what we refer to as **Drift Explainability Reports**,
1010
automatically generated upon the detection of a drift and containing several elements that should help you diagnose the root causes
1111
of the change occurred.
1212

@@ -20,7 +20,7 @@ This is because the elements of the report needs a significant number of samples
2020
If the distribution moves back to the reference before enough samples are collected, the report might not be generated.
2121

2222
Each report is composed of several entities, each providing a different perspective on the data and the drift occurred.
23-
Most of them are specific to a certain [Data Structure], so they might not be available for all tasks.
23+
Most of them are specific to a certain `Data Structure`, so they might not be available for all tasks.
2424

2525
These entities can take the form of tables, plots, or textual explanations.
2626
Observed and analyzed together, they should provide a comprehensive understanding of the drift and its underlying causes.
@@ -35,4 +35,3 @@ These are the entities currently available:
3535
separating power. This entity is available only for tasks with tabular data.
3636

3737
[Monitoring]: index.md
38-
[Data Structure]: ../../api/python/enums.md#datastructure

0 commit comments

Comments
 (0)