Skip to content

Commit 0f3fb31

Browse files
committed
Merge branch 'dev'
2 parents d0db9a8 + 3ebc9d9 commit 0f3fb31

File tree

7 files changed

+2899
-2197
lines changed

7 files changed

+2899
-2197
lines changed

Makefile

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
# === USER PARAMETERS
2-
3-
ifdef OS
4-
export VENV_BIN=.venv/Scripts
5-
else
6-
export VENV_BIN=.venv/bin
7-
endif
8-
91
# == SETUP REPOSITORY AND DEPENDENCIES
102
set-hooks:
113
cp .hooks/pre-commit .git/hooks/pre-commit && chmod +x .git/hooks/pre-commit
@@ -16,7 +8,7 @@ dev-sync:
168
setup: set-hooks dev-sync
179

1810
build-docs:
19-
. $(VENV_BIN)/activate && mkdocs build
11+
uv run mkdocs build
2012

2113
serve-docs:
22-
. $(VENV_BIN)/activate && mkdocs serve
14+
uv run mkdocs serve

md-docs/api/python/client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
## ML3PlatformClient
55
```python
66
ML3PlatformClient(
7-
url: str, api_key: str, timeout: int = 60
7+
url: str, api_key: str, timeout: int = 180
88
)
99
```
1010

md-docs/api/python/enums.md

Lines changed: 57 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,38 @@ Base class for all enums in the ML3 Platform SDK
3131
----
3232

3333

34+
## BooleanLicenceFeature
35+
```python
36+
BooleanLicenceFeature()
37+
```
38+
39+
40+
---
41+
Boolean licence feature
42+
43+
**Fields:**
44+
- EXPLAINABILITY
45+
Whether the company has access to explainability reports
46+
- MONITORING
47+
Whether the company has monitoring feature enabled
48+
- MONITORING_METRICS
49+
Whether the company has monitoring metrics feature enabled
50+
- SEGMENTED_MONITORING
51+
Whether the company has segmented monitoring feature enabled
52+
- RETRAINING
53+
Whether the company has retraining feature enabled
54+
- TOPIC_ANALYSIS
55+
Whether the company has topic analysis feature enabled
56+
- RAG_EVALUATION
57+
Whether the company has RAG evaluation feature enabled
58+
- LLM_SECURITY
59+
Whether the company has LLM security feature enabled
60+
- BUSINESS
61+
Whether the company has business feature enabled
62+
63+
----
64+
65+
3466
## ColumnRole
3567
```python
3668
ColumnRole()
@@ -348,12 +380,12 @@ Image:
348380
- IMAGE_BRIGHTNESS
349381
- IMAGE_CONTRAST
350382
- IMAGE_FOCUS
351-
- IMAGE_COLOR_VARIATION_RED
352-
- IMAGE_COLOR_VARIATION_GREEN
353-
- IMAGE_COLOR_VARIATION_BLUE
383+
- IMAGE_BLUR
384+
- IMAGE_COLOR_VARIATION
385+
- IMAGE_COLOR_CONTRAST
354386

355387
Object detection and semantic segmentation:
356-
- TRACKING_OBJECT_POSITION: polar coordinates of farther object from the center of the image
388+
(position wrt Cartesian axis with origin in the center of the image)
357389

358390
----
359391

@@ -397,6 +429,27 @@ MonitoringTarget()
397429
----
398430

399431

432+
## NumericLicenceFeature
433+
```python
434+
NumericLicenceFeature()
435+
```
436+
437+
438+
---
439+
Numeric licence feature
440+
441+
**Fields:**
442+
- MAX_TASKS
443+
Maximum number of tasks that the company can have
444+
- MAX_USERS
445+
Maximum number of users that the company can have
446+
- DAILY_DATA_BATCH_UPLOAD
447+
Maximum number of data batches that the company can upload
448+
in a day. Only considers production data batches.
449+
450+
----
451+
452+
400453
## ProductKeyStatus
401454
```python
402455
ProductKeyStatus()

md-docs/api/python/models.md

Lines changed: 30 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -870,6 +870,30 @@ false positive and false negative costs for each class
870870
----
871871

872872

873+
## NumericLicenceFeatureInfo
874+
```python
875+
NumericLicenceFeatureInfo()
876+
```
877+
878+
879+
---
880+
Numeric Licence feature info model
881+
882+
883+
**Attributes**
884+
885+
* **feature** : NumericLicenceFeature
886+
Current numeric feature
887+
* **max_value** : int | None
888+
Maximum value of the feature. If None, no limit is set
889+
* **used_value** : int
890+
Used value of the feature. If max_value is None,
891+
this value defaults to 0
892+
893+
894+
----
895+
896+
873897
## NumericSegmentRule
874898
```python
875899
NumericSegmentRule()
@@ -1293,8 +1317,7 @@ SubscriptionPlanInfo()
12931317

12941318
---
12951319
Data model for a subscription plan
1296-
Permission limit set to None means no limit is set
1297-
Expiration date set to None means no expiration is set
1320+
12981321
Product key data are set only if a product key is associated to the
12991322
subscription plan
13001323

@@ -1303,14 +1326,14 @@ subscription plan
13031326

13041327
* **subscription_id** : str
13051328
* **type** : SubscriptionType
1306-
* **max_tasks** : int | None
1307-
* **max_users** : int | None
1308-
* **monitoring** : bool
1309-
* **explainability** : bool
1310-
* **retraining** : bool
1329+
* **boolean_licence_features** : list[BooleanLicenceFeature]
1330+
Features which are either enabled or disabled
1331+
* **numeric_licence_features** : list[NumericLicenceFeatureInfo]]
1332+
Features associated with a usage limit
13111333
* **is_active** : bool
13121334
* **start_date** : date
13131335
* **expiration_date** : date | None
1336+
If set to None, no expiration is set
13141337
* **product_key** : str | None
13151338
* **product_key_status** : ProductKeyStatus | None
13161339

0 commit comments

Comments
 (0)