Skip to content

Commit d0a7c45

Browse files
committed
python3.12
1 parent 9cdc10a commit d0a7c45

File tree

36 files changed

+243
-1101
lines changed

36 files changed

+243
-1101
lines changed

Makefile

Lines changed: 34 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,45 @@
1+
# === USER PARAMETERS
2+
13
ifdef OS
24
export PYTHON_COMMAND=python
5+
export UV_INSTALL_CMD=powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
6+
export VENV_BIN=.venv/Scripts
37
else
4-
export PYTHON_COMMAND=python3.8
8+
export PYTHON_COMMAND=python3.12
9+
export UV_INSTALL_CMD=curl -LsSf https://astral.sh/uv/install.sh | sh
10+
export VENV_BIN=.venv/bin
511
endif
612

13+
export SRC_DIR=ml3_platform_docs
14+
15+
DEPLOY_ENVIRONMENT=$(shell if [ $(findstring main, $(BRANCH_NAME)) ]; then \
16+
echo 'prod'; \
17+
elif [ $(findstring pre, $(BRANCH_NAME)) ]; then \
18+
echo 'pre'; \
19+
else \
20+
echo 'dev'; \
21+
fi)
22+
# If use deploy_environment in the tag system
23+
# `y` => yes
24+
# `n` => no
25+
USE_DEPLOY_ENVIRONMENT=n
26+
27+
# == SETUP REPOSITORY AND DEPENDENCIES
728

8-
setup:
9-
$(PYTHON_COMMAND) -m pip install poetry
10-
poetry env use $(PYTHON_COMMAND)
11-
poetry run pip install --upgrade pip
29+
install-uv:
30+
# install uv package manager
31+
$(UV_INSTALL_CMD)
32+
# create environment
33+
uv venv -p $(PYTHON_COMMAND)
34+
35+
compile:
36+
# install extra dev group
37+
uv pip compile pyproject.toml -o requirements.txt --cache-dir .uv_cache
1238

1339
install:
14-
poetry lock
15-
poetry install
40+
uv pip sync requirements.txt --cache-dir .uv_cache
41+
42+
setup: install-uv compile install
1643

1744
build-docs:
1845
mkdocs build

docs/404.html

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

docs/api/examples/index.html

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

docs/api/index.html

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

docs/api/python/client/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><link href=https://ml-cube.github.io/ml3-platform-docs/api/python/client/ rel=canonical><link href=../ rel=prev><link href=../models/ rel=next><link rel=icon href=../../../assets/favicon.png><meta name=generator content="mkdocs-1.5.3, mkdocs-material-9.5.10"><title>Client - ML cube Platform Documentation</title><link rel=stylesheet href=../../../assets/stylesheets/main.7e359304.min.css><link rel=stylesheet href=../../../assets/stylesheets/palette.06af60db.min.css><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Poppins:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"><style>:root{--md-text-font:"Poppins";--md-code-font:"Roboto Mono"}</style><link rel=stylesheet href=../../../stylesheets/extra.css><script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script> <link href="../../../assets/stylesheets/glightbox.min.css" rel="stylesheet"/><style>
1+
<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><link href=https://ml-cube.github.io/ml3-platform-docs/api/python/client/ rel=canonical><link href=../ rel=prev><link href=../models/ rel=next><link rel=icon href=../../../assets/favicon.png><meta name=generator content="mkdocs-1.5.3, mkdocs-material-9.5.17"><title>Client - ML cube Platform Documentation</title><link rel=stylesheet href=../../../assets/stylesheets/main.bcfcd587.min.css><link rel=stylesheet href=../../../assets/stylesheets/palette.06af60db.min.css><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Poppins:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"><style>:root{--md-text-font:"Poppins";--md-code-font:"Roboto Mono"}</style><link rel=stylesheet href=../../../stylesheets/extra.css><script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script> <link href="../../../assets/stylesheets/glightbox.min.css" rel="stylesheet"/><style>
22
html.glightbox-open { overflow: initial; height: 100%; }
33
.gslide-title { margin-top: 0px; user-select: text; }
44
.gslide-desc { color: #666; user-select: text; }
@@ -255,4 +255,4 @@
255255
</span></code></pre></div> <hr> <p>Test the retrain trigger for a given model.</p> <p><strong>Allowed Roles:</strong></p> <ul> <li>At least <code>WORK_ON_PROJECT</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>model_id</strong> : the id of the model</li> <li><strong>trigger</strong> : the trigger to test</li> </ul> <p><strong>Raises</strong></p> <p><code>SDKClientException</code></p> <h3 id=retrain_model>.retrain_model<a class=headerlink href=#retrain_model title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-78-1><a id=__codelineno-78-1 name=__codelineno-78-1 href=#__codelineno-78-1></a><span class=o>.</span><span class=n>retrain_model</span><span class=p>(</span>
256256
</span><span id=__span-78-2><a id=__codelineno-78-2 name=__codelineno-78-2 href=#__codelineno-78-2></a> <span class=n>model_id</span><span class=p>:</span> <span class=nb>str</span>
257257
</span><span id=__span-78-3><a id=__codelineno-78-3 name=__codelineno-78-3 href=#__codelineno-78-3></a><span class=p>)</span>
258-
</span></code></pre></div> <hr> <p>Retrain a model via the configured retrain trigger.</p> <p><strong>Allowed Roles:</strong></p> <ul> <li>At least <code>WORK_ON_PROJECT</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>model_id</strong> : the id of the model</li> </ul> <p><strong>Raises</strong></p> <p><code>SDKClientException</code></p> </article> </div> <script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var tab,labels=set.querySelector(".tabbed-labels");for(tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> <button type=button class="md-top md-icon" data-md-component=top hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg> Back to top </button> </main> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href=../ class="md-footer__link md-footer__link--prev" aria-label="Previous: ML3 platform client SDK"> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> </div> <div class=md-footer__title> <span class=md-footer__direction> Previous </span> <div class=md-ellipsis> ML3 platform client SDK </div> </div> </a> <a href=../models/ class="md-footer__link md-footer__link--next" aria-label="Next: Models"> <div class=md-footer__title> <span class=md-footer__direction> Next </span> <div class=md-ellipsis> Models </div> </div> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener> Material for MkDocs </a> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "../../..", "features": ["announce.dismiss", "content.action.edit", "content.action.view", "content.code.annotate", "content.code.copy", "content.code.select", "content.tabs.link", "content.tooltips", "navigation.expand", "navigation.footer", "navigation.indexes", "navigation.instant", "navigation.sections", "navigation.expand", "navigation.tabs", "navigation.tabs.sticky", "navigation.top", "navigation.tracking", "search.highlight", "search.share", "search.suggest", "toc.follow"], "search": "../../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script> <script src=../../../assets/javascripts/bundle.8fd75fb4.min.js></script> <script src=../../../javascripts/mathjax.js></script> <script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script> <script src=https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js></script> <script>document$.subscribe(() => {const lightbox = GLightbox({"touchNavigation": true, "loop": false, "zoomable": true, "draggable": true, "openEffect": "zoom", "closeEffect": "zoom", "slideEffect": "slide"});})</script></body> </html>
258+
</span></code></pre></div> <hr> <p>Retrain a model via the configured retrain trigger.</p> <p><strong>Allowed Roles:</strong></p> <ul> <li>At least <code>WORK_ON_PROJECT</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>model_id</strong> : the id of the model</li> </ul> <p><strong>Raises</strong></p> <p><code>SDKClientException</code></p> </article> </div> <script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var tab,labels=set.querySelector(".tabbed-labels");for(tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> <button type=button class="md-top md-icon" data-md-component=top hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg> Back to top </button> </main> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href=../ class="md-footer__link md-footer__link--prev" aria-label="Previous: ML3 platform client SDK"> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> </div> <div class=md-footer__title> <span class=md-footer__direction> Previous </span> <div class=md-ellipsis> ML3 platform client SDK </div> </div> </a> <a href=../models/ class="md-footer__link md-footer__link--next" aria-label="Next: Models"> <div class=md-footer__title> <span class=md-footer__direction> Next </span> <div class=md-ellipsis> Models </div> </div> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener> Material for MkDocs </a> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "../../..", "features": ["announce.dismiss", "content.action.edit", "content.action.view", "content.code.annotate", "content.code.copy", "content.code.select", "content.tabs.link", "content.tooltips", "navigation.expand", "navigation.footer", "navigation.indexes", "navigation.instant", "navigation.sections", "navigation.expand", "navigation.tabs", "navigation.tabs.sticky", "navigation.top", "navigation.tracking", "search.highlight", "search.share", "search.suggest", "toc.follow"], "search": "../../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script> <script src=../../../assets/javascripts/bundle.1e8ae164.min.js></script> <script src=../../../javascripts/mathjax.js></script> <script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script> <script src=https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js></script> <script>document$.subscribe(() => {const lightbox = GLightbox({"touchNavigation": true, "loop": false, "zoomable": true, "draggable": true, "openEffect": "zoom", "closeEffect": "zoom", "slideEffect": "slide"});})</script></body> </html>

0 commit comments

Comments
 (0)