Skip to content

Commit f65a7e7

Browse files
alelavml3alelavml3
committed
sdk docs
1 parent 506637e commit f65a7e7

File tree

10 files changed

+496
-299
lines changed

10 files changed

+496
-299
lines changed

‎docs/api/python/client/index.html‎

Lines changed: 153 additions & 137 deletions
Large diffs are not rendered by default.

‎docs/api/python/enums/index.html‎

Lines changed: 30 additions & 28 deletions
Large diffs are not rendered by default.

‎docs/api/python/exceptions/index.html‎

Lines changed: 26 additions & 24 deletions
Large diffs are not rendered by default.

‎docs/api/python/models/index.html‎

Lines changed: 67 additions & 64 deletions
Large diffs are not rendered by default.

‎docs/search/search_index.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎docs/sitemap.xml‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,112 +2,112 @@
22
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
33
<url>
44
<loc>https://ml-cube.github.io/ml3-platform-docs/</loc>
5-
<lastmod>2024-09-25</lastmod>
5+
<lastmod>2024-10-30</lastmod>
66
<changefreq>daily</changefreq>
77
</url>
88
<url>
99
<loc>https://ml-cube.github.io/ml3-platform-docs/api/</loc>
10-
<lastmod>2024-09-25</lastmod>
10+
<lastmod>2024-10-30</lastmod>
1111
<changefreq>daily</changefreq>
1212
</url>
1313
<url>
1414
<loc>https://ml-cube.github.io/ml3-platform-docs/api/examples/</loc>
15-
<lastmod>2024-09-25</lastmod>
15+
<lastmod>2024-10-30</lastmod>
1616
<changefreq>daily</changefreq>
1717
</url>
1818
<url>
1919
<loc>https://ml-cube.github.io/ml3-platform-docs/api/python/</loc>
20-
<lastmod>2024-09-25</lastmod>
20+
<lastmod>2024-10-30</lastmod>
2121
<changefreq>daily</changefreq>
2222
</url>
2323
<url>
2424
<loc>https://ml-cube.github.io/ml3-platform-docs/api/python/client/</loc>
25-
<lastmod>2024-09-25</lastmod>
25+
<lastmod>2024-10-30</lastmod>
2626
<changefreq>daily</changefreq>
2727
</url>
2828
<url>
2929
<loc>https://ml-cube.github.io/ml3-platform-docs/api/python/enums/</loc>
30-
<lastmod>2024-09-25</lastmod>
30+
<lastmod>2024-10-30</lastmod>
3131
<changefreq>daily</changefreq>
3232
</url>
3333
<url>
3434
<loc>https://ml-cube.github.io/ml3-platform-docs/api/python/exceptions/</loc>
35-
<lastmod>2024-09-25</lastmod>
35+
<lastmod>2024-10-30</lastmod>
3636
<changefreq>daily</changefreq>
3737
</url>
3838
<url>
3939
<loc>https://ml-cube.github.io/ml3-platform-docs/api/python/models/</loc>
40-
<lastmod>2024-09-25</lastmod>
40+
<lastmod>2024-10-30</lastmod>
4141
<changefreq>daily</changefreq>
4242
</url>
4343
<url>
4444
<loc>https://ml-cube.github.io/ml3-platform-docs/api/rest/</loc>
45-
<lastmod>2024-09-25</lastmod>
45+
<lastmod>2024-10-30</lastmod>
4646
<changefreq>daily</changefreq>
4747
</url>
4848
<url>
4949
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/</loc>
50-
<lastmod>2024-09-25</lastmod>
50+
<lastmod>2024-10-30</lastmod>
5151
<changefreq>daily</changefreq>
5252
</url>
5353
<url>
5454
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/data_schema/</loc>
55-
<lastmod>2024-09-25</lastmod>
55+
<lastmod>2024-10-30</lastmod>
5656
<changefreq>daily</changefreq>
5757
</url>
5858
<url>
5959
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/detection_event_rules/</loc>
60-
<lastmod>2024-09-25</lastmod>
60+
<lastmod>2024-10-30</lastmod>
6161
<changefreq>daily</changefreq>
6262
</url>
6363
<url>
6464
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/glossary/</loc>
65-
<lastmod>2024-09-25</lastmod>
65+
<lastmod>2024-10-30</lastmod>
6666
<changefreq>daily</changefreq>
6767
</url>
6868
<url>
6969
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/rbac/</loc>
70-
<lastmod>2024-09-25</lastmod>
70+
<lastmod>2024-10-30</lastmod>
7171
<changefreq>daily</changefreq>
7272
</url>
7373
<url>
7474
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/integrations/</loc>
75-
<lastmod>2024-09-25</lastmod>
75+
<lastmod>2024-10-30</lastmod>
7676
<changefreq>daily</changefreq>
7777
</url>
7878
<url>
7979
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/integrations/data_sources/</loc>
80-
<lastmod>2024-09-25</lastmod>
80+
<lastmod>2024-10-30</lastmod>
8181
<changefreq>daily</changefreq>
8282
</url>
8383
<url>
8484
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/integrations/retrain_triggers/</loc>
85-
<lastmod>2024-09-25</lastmod>
85+
<lastmod>2024-10-30</lastmod>
8686
<changefreq>daily</changefreq>
8787
</url>
8888
<url>
8989
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/modules/</loc>
90-
<lastmod>2024-09-25</lastmod>
90+
<lastmod>2024-10-30</lastmod>
9191
<changefreq>daily</changefreq>
9292
</url>
9393
<url>
9494
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/modules/business/</loc>
95-
<lastmod>2024-09-25</lastmod>
95+
<lastmod>2024-10-30</lastmod>
9696
<changefreq>daily</changefreq>
9797
</url>
9898
<url>
9999
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/modules/labeling/</loc>
100-
<lastmod>2024-09-25</lastmod>
100+
<lastmod>2024-10-30</lastmod>
101101
<changefreq>daily</changefreq>
102102
</url>
103103
<url>
104104
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/modules/monitoring/</loc>
105-
<lastmod>2024-09-25</lastmod>
105+
<lastmod>2024-10-30</lastmod>
106106
<changefreq>daily</changefreq>
107107
</url>
108108
<url>
109109
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/modules/retraining/</loc>
110-
<lastmod>2024-09-25</lastmod>
110+
<lastmod>2024-10-30</lastmod>
111111
<changefreq>daily</changefreq>
112112
</url>
113113
</urlset>

‎docs/sitemap.xml.gz‎

0 Bytes
Binary file not shown.

‎md-docs/api/python/client.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -928,6 +928,37 @@ Get task data schema
928928
* **data_schema** : `DataSchema`
929929

930930

931+
**Raises**
932+
933+
`SDKClientException`
934+
935+
### .get_data_schema_template
936+
```python
937+
.get_data_schema_template(
938+
task_id: str
939+
)
940+
```
941+
942+
---
943+
Get task data schema
944+
945+
**Allowed Roles:**
946+
947+
- At least `PROJECT_VIEW` for that project
948+
- `COMPANY_OWNER`
949+
- `COMPANY_ADMIN`
950+
951+
952+
**Args**
953+
954+
* **task_id** : identifier of the task
955+
956+
957+
**Returns**
958+
959+
* **data_schema** : `DataSchema`
960+
961+
931962
**Raises**
932963

933964
`SDKClientException`

‎md-docs/api/python/enums.md‎

Lines changed: 72 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,20 @@ ColumnRole()
4141
Column role enum
4242
Describe the role of a column
4343

44+
**Fields:**
45+
- INPUT
46+
- INPUT_MASK
47+
- PREDICTION
48+
- TARGET
49+
- ERROR
50+
- ID
51+
- TIME_ID
52+
- INPUT_ADDITIONAL_EMBEDDING
53+
- TARGET_ADDITIONAL_EMBEDDING
54+
- PREDICTION_ADDITIONAL_EMBEDDING
55+
- USER_INPUT
56+
- RETRIEVED_CONTEXT
57+
4458
----
4559

4660

@@ -54,6 +68,13 @@ ColumnSubRole()
5468
Column subrole enum
5569
Describe the subrole of a column
5670

71+
**Fields:**
72+
- RAG_USER_INPUT
73+
- RAG_RETRIEVED_CONTEXT
74+
- MODEL_PROBABILITY
75+
- OBJECT_DETECTION_LABEL_TARGET
76+
- OBJECT_DETECTION_LABEL_PREDICTION
77+
5778
----
5879

5980

@@ -66,6 +87,10 @@ Currency()
6687
---
6788
Currency of to use for the Task
6889

90+
**Fields:**
91+
- EURO
92+
- DOLLAR
93+
6994
----
7095

7196

@@ -98,6 +123,14 @@ DataType()
98123
Data type enum
99124
Describe data type of input
100125

126+
**Fields:**
127+
- FLOAT
128+
- STRING
129+
- CATEGORICAL
130+
- ARRAY_1
131+
- ARRAY_2
132+
- ARRAY_3
133+
101134
----
102135

103136

@@ -145,7 +178,10 @@ DetectionEventType()
145178
---
146179
**Fields:**
147180

148-
- DRIFT
181+
- WARNING_OFF
182+
- WARNING_ON
183+
- DRIFT_ON
184+
- DRIFT_OFF
149185

150186
----
151187

@@ -179,6 +215,10 @@ FileType()
179215

180216
- CSV
181217
- JSON
218+
- PARQUET
219+
- PNG
220+
- JPG
221+
- NPY
182222

183223
----
184224

@@ -210,11 +250,10 @@ ImageMode()
210250
---
211251
Image mode enumeration
212252

213-
Fields
214-
------
215-
RGB: Red, Green, Blue
216-
RGBA: Red, Green, Blue, Alpha
217-
GRAYSCALE: Grayscale
253+
**Fields:**
254+
- RGB
255+
- RGBA
256+
- GRAYSCALE
218257

219258
----
220259

@@ -233,6 +272,7 @@ JobStatus()
233272
- RUNNING
234273
- COMPLETED
235274
- ERROR
275+
- ROLLBACK_COMPLETE
236276

237277
----
238278

@@ -266,6 +306,8 @@ Name of the model metrics that is associated with the model
266306
**Fields:**
267307
- RMSE
268308
- RSQUARE
309+
- ACCURACY
310+
- AVERAGE_PRECISION
269311

270312
----
271313

@@ -284,6 +326,10 @@ MonitoringMetric()
284326
- TEXT_EMOTION
285327
- TEXT_SENTIMENT
286328
- MODEL_PERPLEXITY
329+
- IMAGE_BRIGHTNESS
330+
- IMAGE_CONTRAST
331+
- BBOXES_QUANTITY
332+
- BBOXES_AREA
287333

288334
----
289335

@@ -317,9 +363,10 @@ MonitoringTarget()
317363
- INPUT
318364
- CONCEPT
319365
- PREDICTION
366+
- INPUT_PREDICTION
320367
- USER_INPUT
321-
- USER_INPUT_RETRIEVED_CONTEXT
322368
- RETRIEVED_CONTEXT
369+
- USER_INPUT_RETRIEVED_CONTEXT
323370
- USER_INPUT_MODEL_OUTPUT
324371
- MODEL_OUTPUT_RETRIEVED_CONTEXT
325372

@@ -335,11 +382,10 @@ ProductKeyStatus()
335382
---
336383
Status of a product key
337384

338-
Fields
339-
------
340-
NEW = generated but not yet used product key
341-
VALIDATING = validation requested from client
342-
IN_USE = validated product key, client activated
385+
**Fields:**:
386+
- NEW = generated but not yet used product key
387+
- VALIDATING = validation requested from client
388+
- IN_USE = validated product key, client activated
343389

344390
----
345391

@@ -353,6 +399,11 @@ RetrainTriggerType()
353399
---
354400
Enumeration of the possible retrain triggers
355401

402+
**Fields:**:
403+
- AWS_EVENT_BRIDGE
404+
- GCP_PUBSUB
405+
- AZURE_EVENT_GRID
406+
356407
----
357408

358409

@@ -385,6 +436,7 @@ StoringDataType()
385436
- HISTORICAL
386437
- REFERENCE
387438
- PRODUCTION
439+
- KPI
388440

389441
----
390442

@@ -398,10 +450,9 @@ SubscriptionType()
398450
---
399451
Type of subscription plan of a company
400452

401-
Fields
402-
------
403-
CLOUD: subscription plan for web app or sdk access
404-
EDGE: subscription plan for edge deployment
453+
**Fields:**:
454+
- CLOUD: subscription plan for web app or sdk access
455+
- EDGE: subscription plan for edge deployment
405456

406457
----
407458

@@ -437,6 +488,7 @@ TaskType()
437488
- CLASSIFICATION_MULTICLASS
438489
- CLASSIFICATION_MULTILABEL
439490
- RAG
491+
- OBJECT_DETECTION
440492

441493
----
442494

@@ -450,12 +502,10 @@ TextLanguage()
450502
---
451503
Enumeration of text language used in nlp tasks.
452504

453-
Fields
454-
------
455-
456-
ITALIAN
457-
ENGLISH
458-
MULTILANGUAGE
505+
**Fields:**
506+
- ITALIAN
507+
- ENGLISH
508+
- MULTILANGUAGE
459509

460510
----
461511

0 commit comments

Comments
 (0)