Skip to content

Commit bc5f489

Browse files
New docs
1 parent 7e1944c commit bc5f489

File tree

3 files changed

+84
-43
lines changed

3 files changed

+84
-43
lines changed

md-docs/api/python/client.md

Lines changed: 39 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -425,9 +425,9 @@ Task ID Name Type Status Status start date
425425
### .create_model
426426
```python
427427
.create_model(
428-
task_id: str, name: str, version: str, metric_name: ModelMetricName,
429-
preferred_suggestion_type: SuggestionType, retraining_cost: float = 0.0,
430-
resampled_dataset_size: (int|None) = None
428+
task_id: str, name: str, version: str, metric_name: (ModelMetricName|None),
429+
preferred_suggestion_type: (SuggestionType|None) = None,
430+
retraining_cost: float = 0.0, resampled_dataset_size: (int|None) = None
431431
)
432432
```
433433

@@ -593,7 +593,7 @@ Show a list of models included in a task to stdout.
593593
```
594594
Model Id Task Id Name Version Status Status start timestamp Status insert date Metric Name
595595
------------------------ ------------------------ ---------------------- --------- --------------- ------------------------ -------------------------- --------------------
596-
64fecf7d323311ab78f17280 64fecf7c323311ab78f17262 model_local_experiment v0.0.1 not_initialized 2023-09-11 08:27:41.431000 ModelMetricName.RMSE
596+
64fecf7d323311ab78f17280 64fecf7c323311ab78f17262 model_local_experiment v0.0.1 ok 2023-09-11 08:27:41.431000 ModelMetricName.RMSE
597597
```
598598

599599
### .get_suggestions_info
@@ -1284,6 +1284,41 @@ the retraining report
12841284

12851285
`GetRetrainingReportException`
12861286

1287+
### .get_monitoring_status
1288+
```python
1289+
.get_monitoring_status(
1290+
task_id: str, monitoring_target: MonitoringTarget,
1291+
monitoring_metric: (MonitoringMetric|None) = None
1292+
)
1293+
```
1294+
1295+
---
1296+
Get the monitoring status of a monitoring target (or metric) in a task.
1297+
1298+
**Allowed Roles:**
1299+
1300+
- At least `PROJECT_VIEW` for that project
1301+
- `COMPANY_OWNER`
1302+
- `COMPANY_ADMIN`
1303+
1304+
1305+
**Args**
1306+
1307+
* **task_id** : the identifier of the task
1308+
* **monitoring_target** : the type of monitoring target to get the status
1309+
* **monitoring_metric** : the type of monitoring metric to get the status
1310+
If ``None``, only the monitoring target is considered
1311+
1312+
1313+
**Returns**
1314+
1315+
* **monitoring_quantity_status** : `MonitoringQuantityStatus`
1316+
1317+
1318+
**Raises**
1319+
1320+
`SDKClientException`
1321+
12871322
### .get_jobs
12881323
```python
12891324
.get_jobs(

md-docs/api/python/enums.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,19 @@ Describe the role of a column
3232
----
3333

3434

35+
## ColumnSubRole
36+
```python
37+
ColumnSubRole()
38+
```
39+
40+
41+
---
42+
Column subrole enum
43+
Describe the subrole of a column
44+
45+
----
46+
47+
3548
## Currency
3649
```python
3750
Currency()
@@ -222,36 +235,35 @@ Name of the model metrics that is associated with the model
222235
----
223236

224237

225-
## ModelStatus
238+
## MonitoringMetric
226239
```python
227-
ModelStatus()
240+
MonitoringMetric()
228241
```
229242

230243

231244
---
232245
**Fields:**
233246

234-
- NOT_INITIALIZED
235-
- OK
236-
- WARNING
237-
- DRIFT
247+
- FEATURE
248+
- TEXT_TOXICITY
249+
- TEXT_EMOTION
250+
- TEXT_SENTIMENT
238251

239252
----
240253

241254

242-
## MonitoringMetric
255+
## MonitoringStatus
243256
```python
244-
MonitoringMetric()
257+
MonitoringStatus()
245258
```
246259

247260

248261
---
249262
**Fields:**
250263

251-
- FEATURE
252-
- TEXT_TOXICITY
253-
- TEXT_EMOTION
254-
- TEXT_SENTIMENT
264+
- OK
265+
- WARNING
266+
- DRIFT
255267

256268
----
257269

@@ -269,6 +281,10 @@ MonitoringTarget()
269281
- INPUT
270282
- CONCEPT
271283
- PREDICTION
284+
- USER_INPUT
285+
- USER_INPUT_RETRIEVED_CONTEXT
286+
- USER_INPUT_MODEL_OUTPUT
287+
- MODEL_OUTPUT_RETRIEVED_CONTEXT
272288

273289
----
274290

@@ -335,22 +351,6 @@ type of suggestion
335351
----
336352

337353

338-
## TaskStatus
339-
```python
340-
TaskStatus()
341-
```
342-
343-
344-
---
345-
**Fields:**
346-
347-
- OK
348-
- WARNING
349-
- DRIFT
350-
351-
----
352-
353-
354354
## TaskType
355355
```python
356356
TaskType()

md-docs/api/python/models.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,10 @@ Column base model
166166
* **classes_names** : Optional[list[str]] = None
167167
it is mandatory when the column is the target
168168
in multilabel classification tasks
169+
* **subrole** : Optional[ColumnSubRole] = None
170+
Indicates the subrole of the column. It's used in
171+
RAG tasks to define the role of the input columns
172+
(e.g. user input or retrieved context)
169173

170174

171175
----
@@ -278,7 +282,6 @@ An event created during the detection process.
278282
* **severity_type** : Optional[DetectionEventSeverity]
279283
* **insert_datetime** : str
280284
* **sample_timestamp** : float
281-
* **sample_id** : str
282285
* **model_id** : Optional[str]
283286
* **model_name** : Optional[str]
284287
* **model_version** : Optional[str]
@@ -585,12 +588,6 @@ Base model to define model item
585588
* **task_id** : str
586589
* **name** : str
587590
* **version** : str
588-
* **status** : ModelStatus
589-
* **status_data_start_timestamp** : Optional[float]
590-
* **status_insert_datetime** : datetime
591-
* **prediction_status** : ModelStatus
592-
* **prediction_status_data_start_timestamp** : Optional[float]
593-
* **prediction_status_insert_datetime** : datetime
594591
* **metric_name** : performance or error metric associated with
595592
the model
596593
* **creation_datetime** : Optional[datetime]
@@ -600,6 +597,19 @@ Base model to define model item
600597
----
601598

602599

600+
## MonitoringQuantityStatus
601+
```python
602+
MonitoringQuantityStatus()
603+
```
604+
605+
606+
---
607+
Base model to store the monitoring status
608+
of a monitoring quantity (target or metric)
609+
610+
----
611+
612+
603613
## MulticlassClassificationTaskCostInfo
604614
```python
605615
MulticlassClassificationTaskCostInfo()
@@ -962,10 +972,6 @@ Task model
962972
* **task_id** : str
963973
* **name** : str
964974
* **type** : TaskType
965-
* **input_status** : TaskStatus
966-
* **input_status_insert_datetime** : str
967-
* **concept_status** : TaskStatus
968-
* **concept_status_insert_datetime** : str
969975

970976

971977
----

0 commit comments

Comments
 (0)