| <!doctype html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| <meta name="generator" content="Docusaurus v2.0.0-alpha.70"> |
| <link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Apache Submarine Blog RSS Feed"> |
| <link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Apache Submarine Blog Atom Feed"><title data-react-helmet="true">Model Client | Apache Submarine</title><meta data-react-helmet="true" name="twitter:card" content="summary_large_image"><meta data-react-helmet="true" name="docusaurus_locale" content="en"><meta data-react-helmet="true" name="docusaurus_version" content="current"><meta data-react-helmet="true" name="docusaurus_tag" content="docs-default-current"><meta data-react-helmet="true" property="og:title" content="Model Client | Apache Submarine"><meta data-react-helmet="true" name="description" content="<!--"><meta data-react-helmet="true" property="og:description" content="<!--"><meta data-react-helmet="true" property="og:url" content="https://submarine.apache.org//docs/userDocs/submarine-sdk/model-client"><link data-react-helmet="true" rel="shortcut icon" href="/img/favicon.ico"><link data-react-helmet="true" rel="canonical" href="https://submarine.apache.org//docs/userDocs/submarine-sdk/model-client"><link rel="stylesheet" href="/styles.058db332.css"> |
| <link rel="preload" href="/styles.d28ad9a6.js" as="script"> |
| <link rel="preload" href="/runtime~main.b76d53b2.js" as="script"> |
| <link rel="preload" href="/main.4fdf81d8.js" as="script"> |
| <link rel="preload" href="/1.ecdfe063.js" as="script"> |
| <link rel="preload" href="/2.ff74b3cd.js" as="script"> |
| <link rel="preload" href="/1be78505.ae15da12.js" as="script"> |
| <link rel="preload" href="/c4f5d8e4.93f03c17.js" as="script"> |
| <link rel="preload" href="/79.c30128b5.js" as="script"> |
| <link rel="preload" href="/78.25baa806.js" as="script"> |
| <link rel="preload" href="/935f2afb.4fd644c9.js" as="script"> |
| <link rel="preload" href="/17896441.bdc3ce75.js" as="script"> |
| <link rel="preload" href="/a3083325.97361465.js" as="script"> |
| </head> |
| <body> |
| <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus"> |
| <nav aria-label="Skip navigation links"><button type="button" tabindex="0" class="skipToContent_11B0">Skip to main content</button></nav><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><div aria-label="Navigation bar toggle" class="navbar__toggle" role="button" tabindex="0"><svg aria-label="Menu" width="30" height="30" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></div><a class="navbar__brand" href="/"><img src="https://github.com/apache/submarine/blob/master/website/docs/assets/128-black.png?raw=true" alt="Apache Submarine Site Logo" class="themedImage_YANc themedImage--light_3CMI navbar__logo"><img src="https://github.com/apache/submarine/blob/master/website/docs/assets/128-black.png?raw=true" alt="Apache Submarine Site Logo" class="themedImage_YANc themedImage--dark_3ARp navbar__logo"><strong class="navbar__title">Apache Submarine</strong></a><a class="navbar__item navbar__link navbar__link--active" href="/docs/">Docs</a><a class="navbar__item navbar__link" href="/docs/api/environment">API</a><a class="navbar__item navbar__link" href="/docs/download">Download</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/apache/submarine" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub</a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a class="navbar__item navbar__link">Apache</a><ul class="dropdown__menu"><li><a href="http://www.apache.org/foundation/how-it-works.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Apache Software Foundation</a></li><li><a href="http://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Apache License</a></li><li><a href="http://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Sponsorship</a></li><li><a href="http://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Thanks</a></li></ul></div><div class="react-toggle react-toggle--disabled displayOnlyInLargeViewport_2N3Q"><div class="react-toggle-track"><div class="react-toggle-track-check"><span class="toggle_3NWk">🌜</span></div><div class="react-toggle-track-x"><span class="toggle_3NWk">🌞</span></div></div><div class="react-toggle-thumb"></div><input type="checkbox" disabled="" aria-label="Dark mode toggle" class="react-toggle-screenreader-only"></div><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input type="search" id="search_input_react" placeholder="Search" aria-label="Search" class="navbar__search-input search-bar"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a class="navbar__brand" href="/"><img src="https://github.com/apache/submarine/blob/master/website/docs/assets/128-black.png?raw=true" alt="Apache Submarine Site Logo" class="themedImage_YANc themedImage--light_3CMI navbar__logo"><img src="https://github.com/apache/submarine/blob/master/website/docs/assets/128-black.png?raw=true" alt="Apache Submarine Site Logo" class="themedImage_YANc themedImage--dark_3ARp navbar__logo"><strong class="navbar__title">Apache Submarine</strong></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a class="menu__link navbar__link--active" href="/docs/">Docs</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/api/environment">API</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/download">Download</a></li><li class="menu__list-item"><a href="https://github.com/apache/submarine" target="_blank" rel="noopener noreferrer" class="menu__link">GitHub</a></li><li class="menu__list-item menu__list-item--collapsed"><a role="button" class="menu__link menu__link--sublist">Apache</a><ul class="menu__list"><li class="menu__list-item"><a href="http://www.apache.org/foundation/how-it-works.html" target="_blank" rel="noopener noreferrer" class="menu__link">Apache Software Foundation</a></li><li class="menu__list-item"><a href="http://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="menu__link">Apache License</a></li><li class="menu__list-item"><a href="http://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="menu__link">Sponsorship</a></li><li class="menu__list-item"><a href="http://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="menu__link">Thanks</a></li></ul></li></ul></div></div></div></nav><div class="main-wrapper"><div class="docPage_vMrn"><div class="docSidebarContainer_3Ak5" role="complementary"><div class="sidebar_3gvy"><div class="menu menu--responsive thin-scrollbar menu_1yIk"><button aria-label="Open Menu" aria-haspopup="true" class="button button--secondary button--sm menu__button" type="button"><svg aria-label="Menu" class="sidebarMenuIcon_1CUI" width="24" height="24" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><ul class="menu__list"><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Getting Started</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/">Submarine Local Deployment</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/gettingStarted/kind">Setup a Kubernetes cluster using KinD</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/gettingStarted/notebook">Notebook Tutorial</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/gettingStarted/python-sdk">Submarine Python SDK</a></li></ul></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#!">User Docs</a><ul class="menu__list"><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!" tabindex="0">API documentation</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/userDocs/api/experiment">Experiment REST API</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/userDocs/api/environment">Environment REST API</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/userDocs/api/experiment-template">Experiment Template REST API</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/userDocs/api/notebook">Notebook REST API</a></li></ul></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#!" tabindex="0">Submarine SDK</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/userDocs/submarine-sdk/experiment-client">Experiment Client</a></li><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active active" tabindex="0" href="/docs/userDocs/submarine-sdk/model-client">Model Client</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/userDocs/submarine-sdk/tracking">Tracking</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!" tabindex="0">Submarine Security</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/userDocs/submarine-security/spark-security/README">Submarine Spark Security Plugin</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/userDocs/submarine-security/spark-security/build-submarine-spark-security-plugin">Building Submarine Spark Security Plugin</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!" tabindex="0">Others</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/userDocs/others/mlflow">MLflow UI</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/userDocs/others/tensorboard">Tensorboard</a></li></ul></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Administrator Docs</a><ul class="menu__list"><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!" tabindex="-1">Submarine on Yarn</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/adminDocs/yarn/README">Running Submarine on YARN</a></li></ul></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Developer Docs</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/devDocs/README">Project Architecture</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/devDocs/Dependencies">Dependencies for Submarine</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/devDocs/BuildFromCode">How to Build Submarine</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/devDocs/Development">Development Guide</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/devDocs/IntegrationTestK8s">How to Run Integration K8s Test</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/devDocs/IntegrationTestE2E">How to Run Frontend Integration Test</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Community</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/community/README">Apache Submarine Community</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/community/HowToCommit">Guide for Apache Submarine Committers</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/community/contributing">How To Contribute to Submarine</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Design Docs</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/designDocs/architecture-and-requirements">Architecture and Requirment</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/designDocs/implementation-notes">Implementation Notes</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/designDocs/environments-implementation">Environments Implementation</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/designDocs/experiment-implementation">Experiment Implementation</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/designDocs/notebook-implementation">Notebook Implementation</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/designDocs/storage-implementation">Storage Implementation</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!" tabindex="-1">Submarine Server</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/designDocs/submarine-server/architecture">Submarine Server Implementation</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/designDocs/submarine-server/experimentSpec">Generic Expeiment Spec</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!" tabindex="-1">WIP Design Docs</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/designDocs/wip-designs/submarine-launcher">Submarine Launcher</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/designDocs/wip-designs/submarine-clusterServer">Cluster Server Design - High-Availability</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/designDocs/wip-designs/security-implementation">Security Implementation</a></li></ul></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Releases</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/releases/submarine-release-0.2.0">Apache Submarine Release 0.2.0</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/releases/submarine-release-0.3.0">Apache Submarine Release 0.3.0</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/releases/submarine-release-0.4.0">Apache Submarine Release 0.4.0</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/releases/submarine-release-0.5.0">Apache Submarine Release 0.5.0</a></li></ul></li></ul></div></div></div><main class="docMainContainer_2iGs"><div class="container padding-vert--lg docItemWrapper_1bxp"><div class="row"><div class="col docItemCol_U38p"><div class="docItemContainer_a7m4"><article><header><h1 class="docTitle_Oumm">Model Client</h1></header><div class="markdown"><p>The submarine ModelsClient provides a high-level API for managing and serving your models.</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="modelsclientstart-active-run"></a>ModelsClient.start()-><a href="https://mlflow.org/docs/latest/_modules/mlflow/tracking/fluent.html#ActiveRun" target="_blank" rel="noopener noreferrer">Active Run</a><a class="hash-link" href="#modelsclientstart-active-run" title="Direct link to heading">#</a></h2><ol><li>Start a new Mlflow run</li><li>Direct the logging of the artifacts and metadata to the Run named "worker_i" under Experiment "job_id"</li><li>If in distributed training, worker and job id would be parsed from environment variable</li><li>If in local traning, worker and job id will be generated. |
| :return: Active Run</li></ol><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="modelsclientlog_paramkey-value-none"></a>ModelsClient.log_param(key, value)->None<a class="hash-link" href="#modelsclientlog_paramkey-value-none" title="Direct link to heading">#</a></h2><p>Log parameter under the current run.</p><ul><li><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="parameters"></a>Parameters<a class="hash-link" href="#parameters" title="Direct link to heading">#</a></h3><ul><li><strong>key</strong> – Parameter name (string)</li><li><strong>value</strong> – Parameter value (string, but will be string-ified if not)</li></ul></li><li><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="example"></a>example<a class="hash-link" href="#example" title="Direct link to heading">#</a></h3></li></ul><div class="mdxCodeBlock_1zKU"><div class="codeBlockContent_actS"><div tabindex="0" class="prism-code language-undefined codeBlock_tuNs thin-scrollbar"><div class="codeBlockLines_3uvA" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">from submarine import ModelsClient</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"> |
| </span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">periscope = ModelsClient()</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">with periscope.start() as run:</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> periscope.log_param("learning_rate", 0.01)</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2GIj">Copy</button></div></div><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="modelsclientlog_paramsparams-none"></a>ModelsClient.log_params(params)->None<a class="hash-link" href="#modelsclientlog_paramsparams-none" title="Direct link to heading">#</a></h2><p>Log a batch of params for the current run.</p><ul><li><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="parameters-1"></a>Parameters<a class="hash-link" href="#parameters-1" title="Direct link to heading">#</a></h3><ul><li><strong>params</strong> – Dictionary of param_name: String -> value: (String, but will be string-ified if not)</li></ul></li><li><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="example-1"></a>example<a class="hash-link" href="#example-1" title="Direct link to heading">#</a></h3></li></ul><div class="mdxCodeBlock_1zKU"><div class="codeBlockContent_actS"><div tabindex="0" class="prism-code language-undefined codeBlock_tuNs thin-scrollbar"><div class="codeBlockLines_3uvA" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">from submarine import ModelsClient</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"> |
| </span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">params = {"learning_rate": 0.01, "n_estimators": 10}</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"> |
| </span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">periscope = ModelsClient()</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">with periscope.start() as run:</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> periscope.log_params(params)</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2GIj">Copy</button></div></div><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="modelsclientlog_metricself-key-value-stepnone-none"></a>ModelsClient.log_metric(self, key, value, step=None)->None<a class="hash-link" href="#modelsclientlog_metricself-key-value-stepnone-none" title="Direct link to heading">#</a></h2><p>Log a metric under the current run.</p><ul><li><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="parameters-2"></a>Parameters<a class="hash-link" href="#parameters-2" title="Direct link to heading">#</a></h3><ul><li><strong>key</strong> – Metric name (string).</li><li><strong>value</strong> – Metric value (float). Note that some special values such as +/- Infinity may be replaced by other values depending on the store. For example, the SQLAlchemy store replaces +/- Infinity with max / min float values.</li><li><strong>step</strong> – Metric step (int). Defaults to zero if unspecified.</li></ul></li><li><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="example-2"></a>example<a class="hash-link" href="#example-2" title="Direct link to heading">#</a></h3></li></ul><div class="mdxCodeBlock_1zKU"><div class="codeBlockContent_actS"><div tabindex="0" class="prism-code language-undefined codeBlock_tuNs thin-scrollbar"><div class="codeBlockLines_3uvA" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">from submarine import ModelsClient</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"> |
| </span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">periscope = ModelsClient()</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">with periscope.start() as run:</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> periscope.log_metric("mse", 2500.00)</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2GIj">Copy</button></div></div><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="modelsclientlog_metricsself-metrics-stepnone-none"></a>ModelsClient.log_metrics(self, metrics, step=None)->None<a class="hash-link" href="#modelsclientlog_metricsself-metrics-stepnone-none" title="Direct link to heading">#</a></h2><p>Log multiple metrics for the current run.</p><ul><li><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="parameters-3"></a>Parameters<a class="hash-link" href="#parameters-3" title="Direct link to heading">#</a></h3><ul><li><strong>metrics</strong> – Dictionary of metric_name: String -> value: Float. Note that some special values such as +/- Infinity may be replaced by other values depending on the store. For example, sql based store may replace +/- Infinity with max / min float values.</li><li><strong>step</strong> – A single integer step at which to log the specified Metrics. If unspecified, each metric is logged at step zero.</li></ul></li><li><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="example-3"></a>example<a class="hash-link" href="#example-3" title="Direct link to heading">#</a></h3></li></ul><div class="mdxCodeBlock_1zKU"><div class="codeBlockContent_actS"><div tabindex="0" class="prism-code language-undefined codeBlock_tuNs thin-scrollbar"><div class="codeBlockLines_3uvA" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">from submarine import ModelsClient</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"> |
| </span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">metrics = {"mse": 2500.00, "rmse": 50.00}</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"> |
| </span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">periscope = ModelsClient()</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">with periscope.start() as run:</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> periscope.log_metrics(metrics)</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2GIj">Copy</button></div></div><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="modelsclientload_modelself-name-version--mlflowpyfuncpyfuncmodel"></a>ModelsClient.load_model(self, name, version)-><a href="https://mlflow.org/docs/latest/_modules/mlflow/pyfunc.html#PyFuncModel" target="_blank" rel="noopener noreferrer"> mlflow.pyfunc.PyFuncModel</a><a class="hash-link" href="#modelsclientload_modelself-name-version--mlflowpyfuncpyfuncmodel" title="Direct link to heading">#</a></h2><p>Load a model stored in models Python function format with specific name and version.</p><ul><li><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="parameters-4"></a>Parameters<a class="hash-link" href="#parameters-4" title="Direct link to heading">#</a></h3><ul><li><strong>name</strong> – Name of the containing registered model.(string).</li><li><strong>version</strong> – Version number of the model version.(string).</li></ul></li></ul><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="modelsclientupdate_modelself-name-new_name-none"></a>ModelsClient.update_model(self, name, new_name)->None<a class="hash-link" href="#modelsclientupdate_modelself-name-new_name-none" title="Direct link to heading">#</a></h2><p>Update registered model name.</p><ul><li><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="parameters-5"></a>Parameters<a class="hash-link" href="#parameters-5" title="Direct link to heading">#</a></h3><ul><li><strong>name</strong> – Name of the registered model to update(string).</li><li><strong>new name</strong> – New proposed name for the registered model(string).</li></ul></li></ul><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="modelsclientdelete_modelself-name-version-none"></a>ModelsClient.delete_model(self, name, version)->None<a class="hash-link" href="#modelsclientdelete_modelself-name-version-none" title="Direct link to heading">#</a></h2><p>Delete model version in backend.</p><ul><li><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="parameters-6"></a>Parameters<a class="hash-link" href="#parameters-6" title="Direct link to heading">#</a></h3><ul><li><strong>name</strong> – Name of the containing registered model.(string).</li><li><strong>version</strong> – Version number of the model version.(string).</li></ul></li></ul><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="modelsclientsave_modelself-model_type-model-artifact_path-registered_model_namenone"></a>ModelsClient.save_model(self, model_type, model, artifact_path, registered_model_name=None)<a class="hash-link" href="#modelsclientsave_modelself-model_type-model-artifact_path-registered_model_namenone" title="Direct link to heading">#</a></h2><p>Beta: Save model to server for managment and servering.</p><ul><li><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="parameters-7"></a>Parameters<a class="hash-link" href="#parameters-7" title="Direct link to heading">#</a></h3><ul><li><strong>name</strong> – Name of the containing registered model.(string).</li><li><strong>version</strong> – Version number of the model version.(string).</li></ul></li></ul></div></article><div class="margin-vert--xl"><div class="row"><div class="col"><a href="https://github.com/apache/submarine/edit/master/website/docs/userDocs/submarine-sdk/model-client.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="1.2em" width="1.2em" preserveAspectRatio="xMidYMid meet" role="img" viewBox="0 0 40 40" class="iconEdit_2LL7"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div></div></div><div class="margin-vert--lg"><nav class="pagination-nav" aria-label="Blog list page navigation"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/docs/userDocs/submarine-sdk/experiment-client"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">« Experiment Client</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/docs/userDocs/submarine-sdk/tracking"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Tracking »</div></a></div></nav></div></div></div><div class="col col--3"><div class="tableOfContents_2xL- thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#modelsclientstart-active-run" class="table-of-contents__link">ModelsClient.start()->Active Run</a></li><li><a href="#modelsclientlog_paramkey-value-none" class="table-of-contents__link">ModelsClient.log_param(key, value)->None</a></li><li><a href="#modelsclientlog_paramsparams-none" class="table-of-contents__link">ModelsClient.log_params(params)->None</a></li><li><a href="#modelsclientlog_metricself-key-value-stepnone-none" class="table-of-contents__link">ModelsClient.log_metric(self, key, value, step=None)->None</a></li><li><a href="#modelsclientlog_metricsself-metrics-stepnone-none" class="table-of-contents__link">ModelsClient.log_metrics(self, metrics, step=None)->None</a></li><li><a href="#modelsclientload_modelself-name-version--mlflowpyfuncpyfuncmodel" class="table-of-contents__link">ModelsClient.load_model(self, name, version)-> mlflow.pyfunc.PyFuncModel</a></li><li><a href="#modelsclientupdate_modelself-name-new_name-none" class="table-of-contents__link">ModelsClient.update_model(self, name, new_name)->None</a></li><li><a href="#modelsclientdelete_modelself-name-version-none" class="table-of-contents__link">ModelsClient.delete_model(self, name, version)->None</a></li><li><a href="#modelsclientsave_modelself-model_type-model-artifact_path-registered_model_namenone" class="table-of-contents__link">ModelsClient.save_model(self, model_type, model, artifact_path, registered_model_name=None)</a></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="row footer__links"><div class="col footer__col"><h4 class="footer__title">Docs</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/">Getting Started</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/api/environment">API docs</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">Community</h4><ul class="footer__items"><li class="footer__item"><a href="https://stackoverflow.com/questions/tagged/apache-submarine" target="_blank" rel="noopener noreferrer" class="footer__link-item">Stack Overflow</a></li><li class="footer__item"><a href="https://s.apache.org/slack-invite" target="_blank" rel="noopener noreferrer" class="footer__link-item">Slack</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">More</h4><ul class="footer__items"><li class="footer__item"><a href="https://medium.com/@apache.submarine" target="_blank" rel="noopener noreferrer" class="footer__link-item">Blog</a></li><li class="footer__item"><a href="https://github.com/apache/submarine" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2021 Apache Submarine is Apache2 Licensed software.</div></div></div></footer></div> |
| <script src="/styles.d28ad9a6.js"></script> |
| <script src="/runtime~main.b76d53b2.js"></script> |
| <script src="/main.4fdf81d8.js"></script> |
| <script src="/1.ecdfe063.js"></script> |
| <script src="/2.ff74b3cd.js"></script> |
| <script src="/1be78505.ae15da12.js"></script> |
| <script src="/c4f5d8e4.93f03c17.js"></script> |
| <script src="/79.c30128b5.js"></script> |
| <script src="/78.25baa806.js"></script> |
| <script src="/935f2afb.4fd644c9.js"></script> |
| <script src="/17896441.bdc3ce75.js"></script> |
| <script src="/a3083325.97361465.js"></script> |
| </body> |
| </html> |
