| <!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">PySubmarine Tracking | 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="PySubmarine Tracking | 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/pysubmarine/tracking"><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/pysubmarine/tracking"><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="/63003c38.dbce9bd2.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" href="/docs/">Docs</a><a class="navbar__item navbar__link" href="/docs/api/environment">API</a><a class="navbar__item navbar__link navbar__link--active" 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" 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 navbar__link--active" 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"><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">PySubmarine Tracking</h1></header><div class="markdown"><p>It helps developers use submarine's internal data caching, |
| data exchange, and task tracking capabilities to more efficiently improve the |
| development and execution of machine learning productivity</p><ul><li>Allow data scientist to track distributed ML experiemnt</li><li>Support store ML parameters and metrics in Submarine-server</li><li>Support hdfs, S3 and mysql (Currently we only support mysql)</li></ul><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="quickstart"></a>Quickstart<a class="hash-link" href="#quickstart" title="Direct link to heading">#</a></h2><ol><li><p><a href="https://github.com/apache/submarine/tree/master/dev-support/mini-submarine#run-mini-submarine-image" target="_blank" rel="noopener noreferrer">Start mini-submarine</a></p></li><li><p><a href="https://github.com/apache/submarine/tree/master/dev-support/mini-submarine#run-workbench-server" target="_blank" rel="noopener noreferrer">Start Mysql server in mini-submarine</a></p></li><li><p>Uncomment the log_param and log_metric in |
| <a href="https://github.com/apache/submarine/blob/master/dev-support/mini-submarine/submarine/mnist_distributed.py" target="_blank" rel="noopener noreferrer">mnist_distributed.py</a></p></li><li><p>Start Submarine experiment (e.g., run_submarine_mnist_tony.sh)</p></li></ol><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="functions"></a>Functions<a class="hash-link" href="#functions" title="Direct link to heading">#</a></h2><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="submarineget_tracking_uri"></a><code>submarine.get_tracking_uri()</code><a class="hash-link" href="#submarineget_tracking_uri" title="Direct link to heading">#</a></h3><p>return the tracking URI.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="submarineset_tracking_uriuri"></a><code>submarine.set_tracking_uri(URI)</code><a class="hash-link" href="#submarineset_tracking_uriuri" title="Direct link to heading">#</a></h3><p>set the tracking URI. You can also set the |
| SUBMARINE_TRACKING_URI environment variable to have Submarine find a URI from |
| there. The URI should be database connection string.</p><p><strong>Parameters</strong></p><ul><li>URI - Submarine record data to Mysql server. The database URL |
| is expected in the format <code><dialect>+<driver>://<username>:<password>@<host>:<port>/<database></code>. |
| By default it's <code>mysql+pymysql://submarine:password@localhost:3306/submarine</code>. |
| More detail : <a href="https://docs.sqlalchemy.org/en/latest/core/engines.html#database-urls" target="_blank" rel="noopener noreferrer">SQLAlchemy docs</a></li></ul><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="submarinelog_metrickey-value-step0"></a><code>submarine.log_metric(key, value, step=0)</code><a class="hash-link" href="#submarinelog_metrickey-value-step0" title="Direct link to heading">#</a></h3><p>logs a single key-value metric. The value must always be a number.</p><p><strong>Parameters</strong></p><ul><li>key - Metric name (string).</li><li>value - Metric value (float).</li><li>step - A single integer step at which to log the specified Metrics, |
| by default it's 0.</li></ul><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="submarinelog_paramkey-value"></a><code>submarine.log_param(key, value)</code><a class="hash-link" href="#submarinelog_paramkey-value" title="Direct link to heading">#</a></h3><p>logs a single key-value parameter. The key and value are both strings.</p><p><strong>Parameters</strong></p><ul><li>key - Parameter name (string).</li><li>value - Parameter value (string).</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/pysubmarine/tracking.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"></div><div class="pagination-nav__item pagination-nav__item--next"></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="#quickstart" class="table-of-contents__link">Quickstart</a></li><li><a href="#functions" class="table-of-contents__link">Functions</a><ul><li><a href="#submarineget_tracking_uri" class="table-of-contents__link"><code>submarine.get_tracking_uri()</code></a></li><li><a href="#submarineset_tracking_uriuri" class="table-of-contents__link"><code>submarine.set_tracking_uri(URI)</code></a></li><li><a href="#submarinelog_metrickey-value-step0" class="table-of-contents__link"><code>submarine.log_metric(key, value, step=0)</code></a></li><li><a href="#submarinelog_paramkey-value" class="table-of-contents__link"><code>submarine.log_param(key, value)</code></a></li></ul></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="/63003c38.dbce9bd2.js"></script> |
| </body> |
| </html> |
