Skip to content

Commit 4bf0cd6

Browse files
New metric, aws integration credential fix
1 parent 43fb270 commit 4bf0cd6

File tree

11 files changed

+185
-217
lines changed

11 files changed

+185
-217
lines changed

docs/api/python/client/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,7 @@
300300
</span></code></pre></div> <hr> <p>Set the credentials with the given id as default for 3<sup>rd</sup> party service provider integration.</p> <p><strong>Allowed Roles:</strong></p> <ul> <li>At least <code>UPDATE_PROJECT_INFORMATION</code> for the project where the credentials have been configured</li> <li><code>COMPANY_OWNER</code></li> <li><code>COMPANY_ADMIN</code></li> </ul> <p><strong>Args</strong></p> <ul> <li><strong>credentials_id</strong> : id of the integration credentials to set as default.</li> </ul> <p><strong>Raises</strong></p> <p><code>SDKClientException</code></p> <h3 id=create_aws_integration_credentials>.create_aws_integration_credentials<a class=headerlink href=#create_aws_integration_credentials title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-90-1><a id=__codelineno-90-1 name=__codelineno-90-1 href=#__codelineno-90-1></a><span class=o>.</span><span class=n>create_aws_integration_credentials</span><span class=p>(</span>
301301
</span><span id=__span-90-2><a id=__codelineno-90-2 name=__codelineno-90-2 href=#__codelineno-90-2></a> <span class=n>name</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span> <span class=n>default</span><span class=p>:</span> <span class=nb>bool</span><span class=p>,</span> <span class=n>project_id</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span> <span class=n>role_arn</span><span class=p>:</span> <span class=nb>str</span>
302302
</span><span id=__span-90-3><a id=__codelineno-90-3 name=__codelineno-90-3 href=#__codelineno-90-3></a><span class=p>)</span>
303-
</span></code></pre></div> <hr> <p>Create credentials to integrate with AWS. Returns an object that contains the external_id you will need to configure in your trust policy.</p> <p><strong>Allowed Roles:</strong></p> <ul> <li>At least <code>UPDATE_PROJECT_INFORMATION</code> for the project</li> <li><code>COMPANY_OWNER</code></li> <li><code>COMPANY_ADMIN</code></li> </ul> <p><strong>Args</strong></p> <ul> <li><strong>name</strong> : a simple name to identify this set of credentials</li> <li><strong>default</strong> : whether to use these credentials by default when using an AWS integration</li> <li><strong>project_id</strong> : the project in which these credentials will be configured</li> <li><strong>role_arn</strong> : the ARN of the IAM role that will be assumed by ML cube Platform</li> </ul> <p><strong>Returns</strong></p> <ul> <li><strong>credentials</strong> : <code>SecretAWSCredentials</code></li> </ul> <p><strong>Raises</strong></p> <p><code>SDKClientException</code></p> <h3 id=create_aws_compatible_integration_credentials>.create_aws_compatible_integration_credentials<a class=headerlink href=#create_aws_compatible_integration_credentials title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-91-1><a id=__codelineno-91-1 name=__codelineno-91-1 href=#__codelineno-91-1></a><span class=o>.</span><span class=n>create_aws_compatible_integration_credentials</span><span class=p>(</span>
303+
</span></code></pre></div> <hr> <p>Create credentials to integrate with AWS. Returns an object that contains the trust policy that you need to set on the IAM role on AWS.</p> <p><strong>Allowed Roles:</strong></p> <ul> <li>At least <code>UPDATE_PROJECT_INFORMATION</code> for the project</li> <li><code>COMPANY_OWNER</code></li> <li><code>COMPANY_ADMIN</code></li> </ul> <p><strong>Args</strong></p> <ul> <li><strong>name</strong> : a simple name to identify this set of credentials</li> <li><strong>default</strong> : whether to use these credentials by default when using an AWS integration</li> <li><strong>project_id</strong> : the project in which these credentials will be configured</li> <li><strong>role_arn</strong> : the ARN of the IAM role that will be assumed by ML cube Platform</li> </ul> <p><strong>Returns</strong></p> <ul> <li><strong>credentials</strong> : <code>SecretAWSCredentials</code></li> </ul> <p><strong>Raises</strong></p> <p><code>SDKClientException</code></p> <h3 id=create_aws_compatible_integration_credentials>.create_aws_compatible_integration_credentials<a class=headerlink href=#create_aws_compatible_integration_credentials title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-91-1><a id=__codelineno-91-1 name=__codelineno-91-1 href=#__codelineno-91-1></a><span class=o>.</span><span class=n>create_aws_compatible_integration_credentials</span><span class=p>(</span>
304304
</span><span id=__span-91-2><a id=__codelineno-91-2 name=__codelineno-91-2 href=#__codelineno-91-2></a> <span class=n>name</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span> <span class=n>default</span><span class=p>:</span> <span class=nb>bool</span><span class=p>,</span> <span class=n>project_id</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span> <span class=n>access_key_id</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span>
305305
</span><span id=__span-91-3><a id=__codelineno-91-3 name=__codelineno-91-3 href=#__codelineno-91-3></a> <span class=n>secret_access_key</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span> <span class=n>endpoint_url</span><span class=p>:</span> <span class=p>(</span><span class=nb>str</span><span class=o>|</span><span class=kc>None</span><span class=p>)</span> <span class=o>=</span> <span class=kc>None</span>
306306
</span><span id=__span-91-4><a id=__codelineno-91-4 name=__codelineno-91-4 href=#__codelineno-91-4></a><span class=p>)</span>

docs/api/python/enums/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
</span></code></pre></div> <hr> <p>Enum containing all the job's status that a client can see</p> <p><strong>Fields:</strong></p> <ul> <li>IDLE</li> <li>STARTING</li> <li>RUNNING</li> <li>COMPLETED</li> <li>ERROR</li> </ul> <hr> <h2 id=kpistatus>KPIStatus<a class=headerlink href=#kpistatus title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-15-1><a id=__codelineno-15-1 name=__codelineno-15-1 href=#__codelineno-15-1></a><span class=n>KPIStatus</span><span class=p>()</span>
2626
</span></code></pre></div> <hr> <p><strong>Fields:</strong></p> <ul> <li>NOT_INITIALIZED</li> <li>OK</li> <li>WARNING</li> <li>DRIFT</li> </ul> <hr> <h2 id=modelmetricname>ModelMetricName<a class=headerlink href=#modelmetricname title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-16-1><a id=__codelineno-16-1 name=__codelineno-16-1 href=#__codelineno-16-1></a><span class=n>ModelMetricName</span><span class=p>()</span>
2727
</span></code></pre></div> <hr> <p>Name of the model metrics that is associated with the model</p> <p><strong>Fields:</strong> - RMSE - RSQUARE - ACCURACY - AVERAGE_PRECISION</p> <hr> <h2 id=monitoringmetric>MonitoringMetric<a class=headerlink href=#monitoringmetric title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-17-1><a id=__codelineno-17-1 name=__codelineno-17-1 href=#__codelineno-17-1></a><span class=n>MonitoringMetric</span><span class=p>()</span>
28-
</span></code></pre></div> <hr> <p>Tabular: - FEATURE</p> <hr> <p>Text: - TEXT_TOXICITY - TEXT_EMOTION - TEXT_SENTIMENT - TEXT_LENGTH</p> <p>Model probabilistic output: - MODEL_PERPLEXITY - MODEL_ENTROPY</p> <p>Image: - IMAGE_BRIGHTNESS - IMAGE_CONTRAST - IMAGE_FOCUS - IMAGE_COLOR_VARIATION_RED - IMAGE_COLOR_VARIATION_GREEN - IMAGE_COLOR_VARIATION_BLUE</p> <p>Object detection and semantic segmentation: - OBJECT_TYPES_COUNT: total number of identified object types</p> <hr> <h2 id=monitoringstatus>MonitoringStatus<a class=headerlink href=#monitoringstatus title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-18-1><a id=__codelineno-18-1 name=__codelineno-18-1 href=#__codelineno-18-1></a><span class=n>MonitoringStatus</span><span class=p>()</span>
28+
</span></code></pre></div> <hr> <p>Tabular: - FEATURE</p> <hr> <p>Text: - TEXT_TOXICITY - TEXT_EMOTION - TEXT_SENTIMENT - TEXT_LENGTH</p> <p>Model probabilistic output: - MODEL_PERPLEXITY - MODEL_ENTROPY</p> <p>Image: - IMAGE_BRIGHTNESS - IMAGE_CONTRAST - IMAGE_FOCUS - IMAGE_COLOR_VARIATION_RED - IMAGE_COLOR_VARIATION_GREEN - IMAGE_COLOR_VARIATION_BLUE</p> <p>Object detection and semantic segmentation: - TRACKING_OBJECT_POSITION: polar coordinates of farther object from the center of the image</p> <hr> <h2 id=monitoringstatus>MonitoringStatus<a class=headerlink href=#monitoringstatus title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-18-1><a id=__codelineno-18-1 name=__codelineno-18-1 href=#__codelineno-18-1></a><span class=n>MonitoringStatus</span><span class=p>()</span>
2929
</span></code></pre></div> <hr> <p><strong>Fields:</strong></p> <ul> <li>OK</li> <li>WARNING</li> <li>DRIFT</li> </ul> <hr> <h2 id=monitoringtarget>MonitoringTarget<a class=headerlink href=#monitoringtarget title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-19-1><a id=__codelineno-19-1 name=__codelineno-19-1 href=#__codelineno-19-1></a><span class=n>MonitoringTarget</span><span class=p>()</span>
3030
</span></code></pre></div> <hr> <p><strong>Fields:</strong></p> <ul> <li>ERROR</li> <li>INPUT</li> <li>CONCEPT</li> <li>PREDICTION</li> <li>INPUT_PREDICTION</li> <li>USER_INPUT</li> <li>RETRIEVED_CONTEXT</li> <li>USER_INPUT_RETRIEVED_CONTEXT</li> <li>USER_INPUT_MODEL_OUTPUT</li> <li>MODEL_OUTPUT_RETRIEVED_CONTEXT</li> </ul> <hr> <h2 id=productkeystatus>ProductKeyStatus<a class=headerlink href=#productkeystatus title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-20-1><a id=__codelineno-20-1 name=__codelineno-20-1 href=#__codelineno-20-1></a><span class=n>ProductKeyStatus</span><span class=p>()</span>
3131
</span></code></pre></div> <hr> <p>Status of a product key</p> <p><strong>Fields:</strong>: - NEW = generated but not yet used product key - VALIDATING = validation requested from client - IN_USE = validated product key, client activated</p> <hr> <h2 id=retraintriggertype>RetrainTriggerType<a class=headerlink href=#retraintriggertype title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-21-1><a id=__codelineno-21-1 name=__codelineno-21-1 href=#__codelineno-21-1></a><span class=n>RetrainTriggerType</span><span class=p>()</span>

docs/api/python/models/index.html

Lines changed: 19 additions & 20 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: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2,134 +2,134 @@
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>2025-02-06</lastmod>
5+
<lastmod>2025-02-12</lastmod>
66
</url>
77
<url>
88
<loc>https://ml-cube.github.io/ml3-platform-docs/api/</loc>
9-
<lastmod>2025-02-06</lastmod>
9+
<lastmod>2025-02-12</lastmod>
1010
</url>
1111
<url>
1212
<loc>https://ml-cube.github.io/ml3-platform-docs/api/examples/</loc>
13-
<lastmod>2025-02-06</lastmod>
13+
<lastmod>2025-02-12</lastmod>
1414
</url>
1515
<url>
1616
<loc>https://ml-cube.github.io/ml3-platform-docs/api/python/</loc>
17-
<lastmod>2025-02-06</lastmod>
17+
<lastmod>2025-02-12</lastmod>
1818
</url>
1919
<url>
2020
<loc>https://ml-cube.github.io/ml3-platform-docs/api/python/client/</loc>
21-
<lastmod>2025-02-06</lastmod>
21+
<lastmod>2025-02-12</lastmod>
2222
</url>
2323
<url>
2424
<loc>https://ml-cube.github.io/ml3-platform-docs/api/python/enums/</loc>
25-
<lastmod>2025-02-06</lastmod>
25+
<lastmod>2025-02-12</lastmod>
2626
</url>
2727
<url>
2828
<loc>https://ml-cube.github.io/ml3-platform-docs/api/python/exceptions/</loc>
29-
<lastmod>2025-02-06</lastmod>
29+
<lastmod>2025-02-12</lastmod>
3030
</url>
3131
<url>
3232
<loc>https://ml-cube.github.io/ml3-platform-docs/api/python/models/</loc>
33-
<lastmod>2025-02-06</lastmod>
33+
<lastmod>2025-02-12</lastmod>
3434
</url>
3535
<url>
3636
<loc>https://ml-cube.github.io/ml3-platform-docs/api/rest/</loc>
37-
<lastmod>2025-02-06</lastmod>
37+
<lastmod>2025-02-12</lastmod>
3838
</url>
3939
<url>
4040
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/company/</loc>
41-
<lastmod>2025-02-06</lastmod>
41+
<lastmod>2025-02-12</lastmod>
4242
</url>
4343
<url>
4444
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/data/</loc>
45-
<lastmod>2025-02-06</lastmod>
45+
<lastmod>2025-02-12</lastmod>
4646
</url>
4747
<url>
4848
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/data_schema/</loc>
49-
<lastmod>2025-02-06</lastmod>
49+
<lastmod>2025-02-12</lastmod>
5050
</url>
5151
<url>
5252
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/glossary/</loc>
53-
<lastmod>2025-02-06</lastmod>
53+
<lastmod>2025-02-12</lastmod>
5454
</url>
5555
<url>
5656
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/model/</loc>
57-
<lastmod>2025-02-06</lastmod>
57+
<lastmod>2025-02-12</lastmod>
5858
</url>
5959
<url>
6060
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/project/</loc>
61-
<lastmod>2025-02-06</lastmod>
61+
<lastmod>2025-02-12</lastmod>
6262
</url>
6363
<url>
6464
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/rbac/</loc>
65-
<lastmod>2025-02-06</lastmod>
65+
<lastmod>2025-02-12</lastmod>
6666
</url>
6767
<url>
6868
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/segment/</loc>
69-
<lastmod>2025-02-06</lastmod>
69+
<lastmod>2025-02-12</lastmod>
7070
</url>
7171
<url>
7272
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/task/</loc>
73-
<lastmod>2025-02-06</lastmod>
73+
<lastmod>2025-02-12</lastmod>
7474
</url>
7575
<url>
7676
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/integrations/</loc>
77-
<lastmod>2025-02-06</lastmod>
77+
<lastmod>2025-02-12</lastmod>
7878
</url>
7979
<url>
8080
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/integrations/data_sources/</loc>
81-
<lastmod>2025-02-06</lastmod>
81+
<lastmod>2025-02-12</lastmod>
8282
</url>
8383
<url>
8484
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/integrations/retrain_trigger/</loc>
85-
<lastmod>2025-02-06</lastmod>
85+
<lastmod>2025-02-12</lastmod>
8686
</url>
8787
<url>
8888
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/modules/</loc>
89-
<lastmod>2025-02-06</lastmod>
89+
<lastmod>2025-02-12</lastmod>
9090
</url>
9191
<url>
9292
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/modules/analytics/</loc>
93-
<lastmod>2025-02-06</lastmod>
93+
<lastmod>2025-02-12</lastmod>
9494
</url>
9595
<url>
9696
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/modules/business/</loc>
97-
<lastmod>2025-02-06</lastmod>
97+
<lastmod>2025-02-12</lastmod>
9898
</url>
9999
<url>
100100
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/modules/labeling/</loc>
101-
<lastmod>2025-02-06</lastmod>
101+
<lastmod>2025-02-12</lastmod>
102102
</url>
103103
<url>
104104
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/modules/llm_security/</loc>
105-
<lastmod>2025-02-06</lastmod>
105+
<lastmod>2025-02-12</lastmod>
106106
</url>
107107
<url>
108108
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/modules/rag_evaluation/</loc>
109-
<lastmod>2025-02-06</lastmod>
109+
<lastmod>2025-02-12</lastmod>
110110
</url>
111111
<url>
112112
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/modules/retraining/</loc>
113-
<lastmod>2025-02-06</lastmod>
113+
<lastmod>2025-02-12</lastmod>
114114
</url>
115115
<url>
116116
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/modules/topic_modeling/</loc>
117-
<lastmod>2025-02-06</lastmod>
117+
<lastmod>2025-02-12</lastmod>
118118
</url>
119119
<url>
120120
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/monitoring/</loc>
121-
<lastmod>2025-02-06</lastmod>
121+
<lastmod>2025-02-12</lastmod>
122122
</url>
123123
<url>
124124
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/monitoring/detection_event/</loc>
125-
<lastmod>2025-02-06</lastmod>
125+
<lastmod>2025-02-12</lastmod>
126126
</url>
127127
<url>
128128
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/monitoring/detection_event_rules/</loc>
129-
<lastmod>2025-02-06</lastmod>
129+
<lastmod>2025-02-12</lastmod>
130130
</url>
131131
<url>
132132
<loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/monitoring/drift_explainability/</loc>
133-
<lastmod>2025-02-06</lastmod>
133+
<lastmod>2025-02-12</lastmod>
134134
</url>
135135
</urlset>

docs/sitemap.xml.gz

0 Bytes
Binary file not shown.

docs/user_guide/integrations/index.html

Lines changed: 122 additions & 141 deletions
Large diffs are not rendered by default.

docs/user_guide/monitoring/index.html

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

md-docs/api/python/client.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2725,8 +2725,8 @@ set as default.
27252725

27262726
---
27272727
Create credentials to integrate with AWS. Returns an object
2728-
that contains the external_id you will need to configure in
2729-
your trust policy.
2728+
that contains the trust policy that you need to set on the
2729+
IAM role on AWS.
27302730

27312731
**Allowed Roles:**
27322732

md-docs/api/python/enums.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ Image:
353353
- IMAGE_COLOR_VARIATION_BLUE
354354

355355
Object detection and semantic segmentation:
356-
- OBJECT_TYPES_COUNT: total number of identified object types
356+
- TRACKING_OBJECT_POSITION: polar coordinates of farther object from the center of the image
357357

358358
----
359359

0 commit comments

Comments
 (0)