Skip to content

Commit 36fc8aa

Browse files
Add section in monitoring index.md to explain how to access drift status
1 parent a70c002 commit 36fc8aa

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

md-docs/user_guide/monitoring/index.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,33 @@ under which they are actually monitored. Notice that also this table is subject
9090
| BBOXES_QUANTITY | The average number of predicted bounding boxes per image | PREDICTION | When the task type is Object Detection |
9191

9292

93+
### Monitoring Status
94+
95+
All the entities being monitored are associated with a status, which is defined according to the enumeration [MonitoringStatus].
96+
97+
The status can be one of the following:
98+
99+
- `OK`: the entity is behaving as expected.
100+
- `WARNING`: the entity has shown signs of drifts, but it is still within the acceptable range.
101+
- `DRIFT`: the entity has experienced a significant change and corrective actions should be taken.
102+
103+
You can check the status of the monitored entities in two ways:
104+
105+
- **WebApp**: The homepage of the task displays the status of both monitoring targets and metrics.
106+
- **SDK**: The [get_monitoring_status] method can be used to retrieve the status of the monitored entities programmatically.
107+
This method returns a [MonitoringQuantityStatus], a BaseModel holding the status of the monitoring entity requested.
108+
Otherwise, you can use the [get_task] method, which returns a BaseModel with all the information related to a task, including
109+
the list of [MonitoringQuantityStatus] for all the entities monitored in the task.
110+
111+
93112
[Task]: ../task.md
94113
[set_model_reference]: ../../api/python/client.md#set_model_reference
95114
[add_production_data]: ../../api/python/client.md#add_production_data
96115
[add_historical_data]: ../../api/python/client.md#add_historical_data
97116
[DetectionEvent]: ../../api/python/models.md#detectionevent
98117
[Detection Event Rule]: detection_event_rules.md
99118
[Detection Event]: detection_event.md
119+
[MonitoringStatus]: ../../api/python/enums.md#monitoringstatus
120+
[get_monitoring_status]: ../../api/python/client.md#get_monitoring_status
121+
[MonitoringQuantityStatus]: ../../api/python/models.md#monitoringquantitystatus
122+
[get_task]: ../../api/python/client.md#get_task

0 commit comments

Comments
 (0)