Skip to content

Commit d4c53a5

Browse files
alelavml3alelavml3
committed
update docs
1 parent e69f1d9 commit d4c53a5

File tree

5 files changed

+56
-53
lines changed

5 files changed

+56
-53
lines changed

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,10 @@
3535
</span></code></pre></div></p> <h3 id=create_task>.create_task<a class=headerlink href=#create_task title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-10-1><a id=__codelineno-10-1 name=__codelineno-10-1 href=#__codelineno-10-1></a><span class=o>.</span><span class=n>create_task</span><span class=p>(</span>
3636
</span><span id=__span-10-2><a id=__codelineno-10-2 name=__codelineno-10-2 href=#__codelineno-10-2></a> <span class=n>project_id</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span> <span class=n>name</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span> <span class=n>tags</span><span class=p>:</span> <span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>],</span> <span class=n>task_type</span><span class=p>:</span> <span class=n>TaskType</span><span class=p>,</span>
3737
</span><span id=__span-10-3><a id=__codelineno-10-3 name=__codelineno-10-3 href=#__codelineno-10-3></a> <span class=n>data_structure</span><span class=p>:</span> <span class=n>DataStructure</span><span class=p>,</span> <span class=n>cost_info</span><span class=p>:</span> <span class=p>(</span><span class=n>TaskCostInfoUnion</span><span class=o>|</span><span class=kc>None</span><span class=p>)</span> <span class=o>=</span> <span class=kc>None</span><span class=p>,</span>
38-
</span><span id=__span-10-4><a id=__codelineno-10-4 name=__codelineno-10-4 href=#__codelineno-10-4></a> <span class=n>optional_target</span><span class=p>:</span> <span class=nb>bool</span> <span class=o>=</span> <span class=kc>False</span><span class=p>,</span> <span class=n>text_language</span><span class=p>:</span> <span class=p>(</span><span class=n>TextLanguage</span><span class=o>|</span><span class=kc>None</span><span class=p>)</span> <span class=o>=</span> <span class=kc>None</span>
39-
</span><span id=__span-10-5><a id=__codelineno-10-5 name=__codelineno-10-5 href=#__codelineno-10-5></a><span class=p>)</span>
40-
</span></code></pre></div> <hr> <p>Create a task inside the project.</p> <p><strong>Allowed Roles:</strong></p> <ul> <li>At least <code>PROJECT_EDIT</code> for that project</li> <li><code>COMPANY_OWNER</code></li> <li><code>COMPANY_ADMIN</code></li> </ul> <p><strong>Args</strong></p> <ul> <li><strong>project_id</strong> : the identifier of the project</li> <li><strong>name</strong> : the name of the task</li> <li><strong>tags</strong> : a list of tags associated with the task</li> <li><strong>task_type</strong> : the type of the task. See <code>TaskType</code> documentation for more information</li> <li><strong>data_structure</strong> : type of data in the task</li> <li><strong>cost_info</strong> : optional argument that specify the cost information of the task</li> <li><strong>optional_target</strong> : True if the target value in not always available. This changes the behaviour and the detection phase of ML cube Platform that will analyse production data without considering the actual target</li> <li><strong>text_language</strong> : required for NLP tasks, it specifies the language used in the task.</li> </ul> <p><strong>Returns</strong></p> <ul> <li><strong>task_id</strong> : <code>str</code></li> </ul> <p><strong>Raises</strong></p> <p><code>CreateTaskException</code></p> <h3 id=update_task>.update_task<a class=headerlink href=#update_task title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-11-1><a id=__codelineno-11-1 name=__codelineno-11-1 href=#__codelineno-11-1></a><span class=o>.</span><span class=n>update_task</span><span class=p>(</span>
38+
</span><span id=__span-10-4><a id=__codelineno-10-4 name=__codelineno-10-4 href=#__codelineno-10-4></a> <span class=n>optional_target</span><span class=p>:</span> <span class=nb>bool</span> <span class=o>=</span> <span class=kc>False</span><span class=p>,</span> <span class=n>text_language</span><span class=p>:</span> <span class=p>(</span><span class=n>TextLanguage</span><span class=o>|</span><span class=kc>None</span><span class=p>)</span> <span class=o>=</span> <span class=kc>None</span><span class=p>,</span>
39+
</span><span id=__span-10-5><a id=__codelineno-10-5 name=__codelineno-10-5 href=#__codelineno-10-5></a> <span class=n>positive_class</span><span class=p>:</span> <span class=p>(</span><span class=nb>str</span><span class=o>|</span><span class=nb>int</span><span class=o>|</span><span class=nb>bool</span><span class=o>|</span><span class=kc>None</span><span class=p>)</span> <span class=o>=</span> <span class=kc>None</span>
40+
</span><span id=__span-10-6><a id=__codelineno-10-6 name=__codelineno-10-6 href=#__codelineno-10-6></a><span class=p>)</span>
41+
</span></code></pre></div> <hr> <p>Create a task inside the project.</p> <p><strong>Allowed Roles:</strong></p> <ul> <li>At least <code>PROJECT_EDIT</code> for that project</li> <li><code>COMPANY_OWNER</code></li> <li><code>COMPANY_ADMIN</code></li> </ul> <p><strong>Args</strong></p> <ul> <li><strong>project_id</strong> : the identifier of the project</li> <li><strong>name</strong> : the name of the task</li> <li><strong>tags</strong> : a list of tags associated with the task</li> <li><strong>task_type</strong> : the type of the task. See <code>TaskType</code> documentation for more information</li> <li><strong>data_structure</strong> : type of data in the task</li> <li><strong>cost_info</strong> : optional argument that specify the cost information of the task</li> <li><strong>optional_target</strong> : True if the target value in not always available. This changes the behaviour and the detection phase of ML cube Platform that will analyse production data without considering the actual target</li> <li><strong>text_language</strong> : required for NLP tasks, it specifies the language used in the task.</li> <li><strong>positive_class</strong> : required for binary classification tasks, it specifies the positive class of the target.</li> </ul> <p><strong>Returns</strong></p> <ul> <li><strong>task_id</strong> : <code>str</code></li> </ul> <p><strong>Raises</strong></p> <p><code>CreateTaskException</code></p> <h3 id=update_task>.update_task<a class=headerlink href=#update_task title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-11-1><a id=__codelineno-11-1 name=__codelineno-11-1 href=#__codelineno-11-1></a><span class=o>.</span><span class=n>update_task</span><span class=p>(</span>
4142
</span><span id=__span-11-2><a id=__codelineno-11-2 name=__codelineno-11-2 href=#__codelineno-11-2></a> <span class=n>task_id</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span> <span class=n>name</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><span class=p>,</span> <span class=n>tags</span><span class=p>:</span> <span class=p>(</span><span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>]</span><span class=o>|</span><span class=kc>None</span><span class=p>)</span> <span class=o>=</span> <span class=kc>None</span><span class=p>,</span>
4243
</span><span id=__span-11-3><a id=__codelineno-11-3 name=__codelineno-11-3 href=#__codelineno-11-3></a> <span class=n>cost_info</span><span class=p>:</span> <span class=p>(</span><span class=n>TaskCostInfoUnion</span><span class=o>|</span><span class=kc>None</span><span class=p>)</span> <span class=o>=</span> <span class=kc>None</span>
4344
</span><span id=__span-11-4><a id=__codelineno-11-4 name=__codelineno-11-4 href=#__codelineno-11-4></a><span class=p>)</span>

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

Lines changed: 29 additions & 27 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-05-03</lastmod>
5+
<lastmod>2024-06-12</lastmod>
66
<changefreq>daily</changefreq>
77
</url>
88
<url>
99
<loc>https://ml-cube.github.io/ml3-platform-docs/api/</loc>
10-
<lastmod>2024-05-03</lastmod>
10+
<lastmod>2024-06-12</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-05-03</lastmod>
15+
<lastmod>2024-06-12</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-05-03</lastmod>
20+
<lastmod>2024-06-12</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-05-03</lastmod>
25+
<lastmod>2024-06-12</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-05-03</lastmod>
30+
<lastmod>2024-06-12</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-05-03</lastmod>
35+
<lastmod>2024-06-12</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-05-03</lastmod>
40+
<lastmod>2024-06-12</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-05-03</lastmod>
45+
<lastmod>2024-06-12</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-05-03</lastmod>
50+
<lastmod>2024-06-12</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-05-03</lastmod>
55+
<lastmod>2024-06-12</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-05-03</lastmod>
60+
<lastmod>2024-06-12</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-05-03</lastmod>
65+
<lastmod>2024-06-12</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-05-03</lastmod>
70+
<lastmod>2024-06-12</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-05-03</lastmod>
75+
<lastmod>2024-06-12</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-05-03</lastmod>
80+
<lastmod>2024-06-12</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-05-03</lastmod>
85+
<lastmod>2024-06-12</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-05-03</lastmod>
90+
<lastmod>2024-06-12</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-05-03</lastmod>
95+
<lastmod>2024-06-12</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-05-03</lastmod>
100+
<lastmod>2024-06-12</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-05-03</lastmod>
105+
<lastmod>2024-06-12</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-05-03</lastmod>
110+
<lastmod>2024-06-12</lastmod>
111111
<changefreq>daily</changefreq>
112112
</url>
113113
</urlset>

‎docs/sitemap.xml.gz‎

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)