sdk docs

Author: alelavml3

md-docs/api/python/client.md

@@ -4,7 +4,7 @@
 ## ML3PlatformClient
 ```python 
 ML3PlatformClient(
-   url: str, api_key: str, timeout: int = 60
+   url: str, api_key: str, timeout: int = 180
 )
 ```
 
@@ -943,8 +943,8 @@ reference of this new model with set_reference request.
 ### .update_model_version_from_time_range
 ```python
 .update_model_version_from_time_range(
-   model_id: str, new_model_version: str, from_timestamp: float,
-   to_timestamp: float
+   model_id: str, new_model_version: str, default_reference: ReferenceInfo,
+   segment_references: (list[ReferenceInfo]|None) = None
 )
 ```
 
@@ -969,8 +969,8 @@ using the method `wait_job_completion(job_id)`
 
 * **model_id**  : the identifier of the model
 * **new_model_version**  : the new version of the model
-from_timestamp
-to_timestamp
+* **default_reference**  : the list of time intervals used as default reference
+* **segment_references**  : list of segment specific time intervals used as reference for the segments
 
 
 **Raises**
@@ -1207,7 +1207,8 @@ using the method `wait_job_completion(job_id)`
 ### .set_model_reference
 ```python
 .set_model_reference(
-   model_id: str, from_timestamp: float, to_timestamp: float
+   model_id: str, default_reference: ReferenceInfo,
+   segment_references: (list[ReferenceInfo]|None) = None
 )
 ```
 
@@ -1231,8 +1232,10 @@ using the method `wait_job_completion(job_id)`
 **Args**
 
 * **model_id**  : the identifier of the model
-from_timestamp
-to_timestamp
+* **default_reference**  : the list of time intervals used as default reference, they are combined with OR operator
+* **segment_references**  : a dictionary containing for each specified segments constraints on the time intervals,
+    they are combined with OR operator among themselves and with AND operator with the time intervals.
+
 
 
 **Returns**

md-docs/api/python/enums.md

@@ -31,6 +31,38 @@ Base class for all enums in the ML3 Platform SDK
 ----
 
 
+## BooleanLicenceFeature
+```python 
+BooleanLicenceFeature()
+```
+
+
+---
+Boolean licence feature
+
+**Fields:**
+- EXPLAINABILITY
+    Whether the company has access to explainability reports
+- MONITORING
+    Whether the company has monitoring feature enabled
+- MONITORING_METRICS
+    Whether the company has monitoring metrics feature enabled
+- SEGMENTED_MONITORING
+    Whether the company has segmented monitoring feature enabled
+- RETRAINING
+    Whether the company has retraining feature enabled
+- TOPIC_ANALYSIS
+    Whether the company has topic analysis feature enabled
+- RAG_EVALUATION
+    Whether the company has RAG evaluation feature enabled
+- LLM_SECURITY
+    Whether the company has LLM security feature enabled
+- BUSINESS
+    Whether the company has business feature enabled
+
+----
+
+
 ## ColumnRole
 ```python 
 ColumnRole()
@@ -348,12 +380,12 @@ Image:
     - IMAGE_BRIGHTNESS
     - IMAGE_CONTRAST
     - IMAGE_FOCUS
-    - IMAGE_COLOR_VARIATION_RED
-    - IMAGE_COLOR_VARIATION_GREEN
-    - IMAGE_COLOR_VARIATION_BLUE
+    - IMAGE_BLUR
+    - IMAGE_COLOR_VARIATION
+    - IMAGE_COLOR_CONTRAST
 
 Object detection and semantic segmentation:
-    - TRACKING_OBJECT_POSITION: polar coordinates of farther object from the center of the image
+        (position wrt Cartesian axis with origin in the center of the image)
 
 ----
 
@@ -397,6 +429,27 @@ MonitoringTarget()
 ----
 
 
+## NumericLicenceFeature
+```python 
+NumericLicenceFeature()
+```
+
+
+---
+Numeric licence feature
+
+**Fields:**
+- MAX_TASKS
+    Maximum number of tasks that the company can have
+- MAX_USERS
+    Maximum number of users that the company can have
+- DAILY_DATA_BATCH_UPLOAD
+    Maximum number of data batches that the company can upload
+    in a day. Only considers production data batches.
+
+----
+
+
 ## ProductKeyStatus
 ```python 
 ProductKeyStatus()

md-docs/api/python/models.md

@@ -223,9 +223,9 @@ Column base model
 * **model_id**  : Optional[str] = None
 * **dims**  : Optional[tuple[int]] = None
     it is mandatory when data_type is Array
-* **tol**  : Optional[int] = 0
+* **tol**  : Optional[int | None] = 0
     Tolerance for ImageData width and height.
-    Images can be loaded with size (w +- tol, h +- tol) pixels
+    Images can be loaded with size (w ± tol, h ± tol) pixels
 * **classes_names**  : Optional[list[str]] = None
     it is mandatory when the column is the target
     in multilabel classification tasks
@@ -870,6 +870,30 @@ false positive and false negative costs for each class
 ----
 
 
+## NumericLicenceFeatureInfo
+```python 
+NumericLicenceFeatureInfo()
+```
+
+
+---
+Numeric Licence feature info model
+
+
+**Attributes**
+
+* **feature**  : NumericLicenceFeature
+    Current numeric feature
+* **max_value**  : int | None
+    Maximum value of the feature. If None, no limit is set
+* **used_value**  : int
+    Used value of the feature. If max_value is None,
+    this value defaults to 0
+
+
+----
+
+
 ## NumericSegmentRule
 ```python 
 NumericSegmentRule()
@@ -919,6 +943,30 @@ Project model
 ----
 
 
+## ReferenceInfo
+```python 
+ReferenceInfo()
+```
+
+
+---
+Reference info
+
+
+**Attributes**
+
+* **time_intervals**  : list[tuple[float, float]]
+    List of time intervals used as model reference with tuples
+    containing the start and end time of the intervals
+    Can be the default time intervals or segment specific ones
+* **segment_id**  : str | None
+    Segment id associated to the model reference considered, None if the
+    reference is for the whole population (default)
+
+
+----
+
+
 ## RegressionTaskCostInfo
 ```python 
 RegressionTaskCostInfo()
@@ -1269,8 +1317,7 @@ SubscriptionPlanInfo()
 
 ---
 Data model for a subscription plan
-Permission limit set to None means no limit is set
-Expiration date set to None means no expiration is set
+
 Product key data are set only if a product key is associated to the
 subscription plan
 
@@ -1279,14 +1326,14 @@ subscription plan
 
 * **subscription_id**  : str
 * **type**  : SubscriptionType
-* **max_tasks**  : int | None
-* **max_users**  : int | None
-* **monitoring**  : bool
-* **explainability**  : bool
-* **retraining**  : bool
+* **boolean_licence_features**  : list[BooleanLicenceFeature]
+    Features which are either enabled or disabled
+* **numeric_licence_features**  : list[NumericLicenceFeatureInfo]]
+    Features associated with a usage limit
 * **is_active**  : bool
 * **start_date**  : date
 * **expiration_date**  : date | None
+    If set to None, no expiration is set
 * **product_key**  : str | None
 * **product_key_status**  : ProductKeyStatus | None