| <!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">Experiment Template REST API | 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="0.6.0"><meta data-react-helmet="true" name="docusaurus_tag" content="docs-default-0.6.0"><meta data-react-helmet="true" property="og:title" content="Experiment Template REST API | 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/api/experiment-template"><link data-react-helmet="true" rel="shortcut icon" href="/img/submarine.ico"><link data-react-helmet="true" rel="canonical" href="https://submarine.apache.org//docs/api/experiment-template"><link rel="stylesheet" href="/styles.39775f96.css"> |
| <link rel="preload" href="/styles.6ddab7ad.js" as="script"> |
| <link rel="preload" href="/runtime~main.943b9f3a.js" as="script"> |
| <link rel="preload" href="/main.92db4fb0.js" as="script"> |
| <link rel="preload" href="/1.dab80c77.js" as="script"> |
| <link rel="preload" href="/2.6a1a8326.js" as="script"> |
| <link rel="preload" href="/1f391b9e.f22e8160.js" as="script"> |
| <link rel="preload" href="/128.10c43f42.js" as="script"> |
| <link rel="preload" href="/58f10d9f.87a860a5.js" as="script"> |
| <link rel="preload" href="/17896441.be8f95bf.js" as="script"> |
| <link rel="preload" href="/f6956115.1f3df0b9.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="/img/icons/128.png" alt="Apache Submarine Site Logo" class="themedImage_YANc themedImage--light_3CMI navbar__logo"><img src="/img/icons/128.png" 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/gettingStarted/quickstart">Docs</a><a class="navbar__item navbar__link navbar__link--active" 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"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a class="navbar__item navbar__link" href="/docs/">0.6.0</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/next/api/experiment-template">master 🏃</a></li><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/docs/api/experiment-template">0.6.0</a></li><li><a class="dropdown__link" href="/versions">All versions</a></li></ul></div><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="https://www.apache.org/foundation/how-it-works.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Apache Software Foundation</a></li><li><a href="https://www.apache.org/events/current-event" target="_blank" rel="noopener noreferrer" class="dropdown__link">Events</a></li><li><a href="https://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Apache License</a></li><li><a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Thanks</a></li><li><a href="https://www.apache.org/security/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Security</a></li><li><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Sponsorship</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="/img/icons/128.png" alt="Apache Submarine Site Logo" class="themedImage_YANc themedImage--light_3CMI navbar__logo"><img src="/img/icons/128.png" 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/gettingStarted/quickstart">Docs</a></li><li class="menu__list-item"><a class="menu__link navbar__link--active" 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 role="button" class="menu__link menu__link--sublist">Versions</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/next/api/experiment-template">master 🏃</a></li><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active" href="/docs/api/experiment-template">0.6.0</a></li><li class="menu__list-item"><a class="menu__link" href="/versions">All versions</a></li></ul></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="https://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="https://www.apache.org/events/current-event" target="_blank" rel="noopener noreferrer" class="menu__link">Events</a></li><li class="menu__list-item"><a href="https://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="menu__link">Apache License</a></li><li class="menu__list-item"><a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="menu__link">Thanks</a></li><li class="menu__list-item"><a href="https://www.apache.org/security/" target="_blank" rel="noopener noreferrer" class="menu__link">Security</a></li><li class="menu__list-item"><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="menu__link">Sponsorship</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"><a class="menu__link" href="/docs/api/environment">Environment REST API</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/api/experiment">Experiment REST API</a></li><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active active" href="/docs/api/experiment-template">Experiment Template REST API</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/api/notebook">Notebook REST API</a></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><div><span class="badge badge--secondary">Version: 0.6.0</span></div><header><h1 class="docTitle_Oumm">Experiment Template REST API</h1></header><div class="markdown"><blockquote><p>Note: The Experiment API is in the alpha stage which is subjected to incompatible changes in |
| future releases.</p></blockquote><p>Developers can register a parameterized experiment as an experiment template, |
| For example, if the developer wants to change the following "--learning_rate=0.1" to parameters.</p><div class="mdxCodeBlock_1zKU"><div class="codeBlockContent_actS"><div tabindex="0" class="prism-code language-json codeBlock_tuNs thin-scrollbar"><div class="codeBlockLines_3uvA" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token property">"experimentSpec"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"meta"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"cmd"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"python /var/tf_mnist/mnist_with_summaries.py --log_dir=/train/log --learning_rate=0.1 --batch_size=150"</span><span class="token plain"></span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"..."</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"..."</span><span class="token plain"></span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2GIj">Copy</button></div></div><p>They can use two curly braces as placeholders, the template format will be as</p><div class="mdxCodeBlock_1zKU"><div class="codeBlockContent_actS"><div tabindex="0" class="prism-code language-json codeBlock_tuNs thin-scrollbar"><div class="codeBlockLines_3uvA" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token property">"experimentSpec"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"meta"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"cmd"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"python /var/tf_mnist/mnist_with_summaries.py --log_dir=/train/log --learning_rate={{learning_rate}} --batch_size=150"</span><span class="token plain"></span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"..."</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"..."</span><span class="token plain"></span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2GIj">Copy</button></div></div><p>The template parameters format will be as</p><div class="mdxCodeBlock_1zKU"><div class="codeBlockContent_actS"><div tabindex="0" class="prism-code language-json codeBlock_tuNs thin-scrollbar"><div class="codeBlockLines_3uvA" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"name"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"learning_rate"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"value"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.1</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"required"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"description"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"This is learning_rate of training."</span><span class="token plain"></span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2GIj">Copy</button></div></div><p>name: placeholder name |
| value; default value |
| required: Indicates whether the user must enter parameters, when required is true, value can be null |
| description: Introduction of this parameter</p><p>Users can use existing experiment templates and adjust the default value to create experiments. |
| After the user submits the experiment template, the submarine server finds the corresponding template based on the name. And the template handler converts input parameters to an actual experiment, such as a distributed TF experiment.</p><p>The "replicas", "cpu", "memory" of resources will be automatically parameterized, so developers do not need to add them. |
| For example, if there are "Ps" and "Worker" under spec, the following parameters will be automatically appended.</p><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">spec.Ps.replicas</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">spec.Ps.resourceMap.cpu</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">spec.Ps.resourceMap.memory</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">spec.Worker.replicas</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">spec.Worker.resourceMap.cpu</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">spec.Worker.resourceMap.memory</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="create-experiment-template"></a>Create experiment template<a class="hash-link" href="#create-experiment-template" title="Direct link to heading">#</a></h2><p><code>POST /api/v1/template</code></p><p><strong>Example Request</strong></p><div class="mdxCodeBlock_1zKU"><div class="codeBlockContent_actS"><div tabindex="0" class="prism-code language-sh 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">curl -X POST -H "Content-Type: application/json" -d '</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">{</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "name": "my-tf-mnist-template",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "author": "author",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "description": "This is a template to run tf-mnist",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": [{</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "name": "learning_rate",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "value": 0.1,</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "required": true,</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "description": "This is learning_rate of training."</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> {</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "name": "batch_size",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "value": 150,</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "required": true,</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "description": "This is batch_size of training."</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> {</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "name": "experiment_name",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "value": "tf-mnist1",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "required": true,</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "description": "the name of experiment."</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> ],</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "experimentSpec": {</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "meta": {</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "cmd": "python /var/tf_mnist/mnist_with_summaries.py --log_dir=/train/log --learning_rate={{learning_rate}} --batch_size={{batch_size}}",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "name": "{{experiment_name}}",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "envVars": {</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "ENV1": "ENV1"</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "framework": "TensorFlow",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "namespace": "default"</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "spec": {</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "Ps": {</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "replicas": 1,</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "resources": "cpu=1,memory=1024M"</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "Worker": {</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "replicas": 1,</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "resources": "cpu=1,memory=1024M"</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "environment": {</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "image": "apache/submarine:tf-mnist-with-summaries-1.0"</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">}</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">' http://127.0.0.1:32080/api/v1/template</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2GIj">Copy</button></div></div><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="list-experiment-template"></a>List experiment template<a class="hash-link" href="#list-experiment-template" title="Direct link to heading">#</a></h3><p><code>GET /api/v1/template</code></p><p><strong>Example Request:</strong></p><div class="mdxCodeBlock_1zKU"><div class="codeBlockContent_actS"><div tabindex="0" class="prism-code language-sh 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">curl -X GET http://127.0.0.1:32080/api/v1/template</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2GIj">Copy</button></div></div><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="get-experiment-template"></a>Get experiment template<a class="hash-link" href="#get-experiment-template" title="Direct link to heading">#</a></h3><p><code>GET /api/v1/template/{name}</code></p><p><strong>Example Request:</strong></p><div class="mdxCodeBlock_1zKU"><div class="codeBlockContent_actS"><div tabindex="0" class="prism-code language-sh 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">curl -X GET http://127.0.0.1:32080/api/v1/template/my-tf-mnist-template</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2GIj">Copy</button></div></div><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="patch-template"></a>Patch template<a class="hash-link" href="#patch-template" title="Direct link to heading">#</a></h3><p><code>PATCH /api/v1/template/{name}</code></p><div class="mdxCodeBlock_1zKU"><div class="codeBlockContent_actS"><div tabindex="0" class="prism-code language-sh 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">curl -X PATCH -H "Content-Type: application/json" -d '</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">{</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "name": "my-tf-mnist-template",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "author": "author-new",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "description": "This is a template to run tf-mnist",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": [{</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "name": "learning_rate",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "value": 0.1,</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "required": true,</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "description": "This is learning_rate of training."</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> {</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "name": "batch_size",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "value": 150,</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "required": true,</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "description": "This is batch_size of training."</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> {</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "name": "experiment_name",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "value": "tf-mnist1",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "required": true,</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "description": "the name of experiment."</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> ],</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "experimentSpec": {</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "meta": {</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "cmd": "python /var/tf_mnist/mnist_with_summaries.py --log_dir=/train/log --learning_rate={{learning_rate}} --batch_size={{batch_size}}",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "name": "{{experiment_name}}",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "envVars": {</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "ENV1": "ENV1"</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "framework": "TensorFlow",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "namespace": "default"</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "spec": {</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "Ps": {</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "replicas": 1,</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "resources": "cpu=1,memory=1024M"</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "Worker": {</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "replicas": 1,</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "resources": "cpu=1,memory=1024M"</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "environment": {</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "image": "apache/submarine:tf-mnist-with-summaries-1.0"</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">}</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">' http://127.0.0.1:32080/api/v1/template/my-tf-mnist-template</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2GIj">Copy</button></div></div><blockquote><p>"description", "parameters", "experimentSpec", "author" etc can be updated using this API. |
| "name" of experiment template is not supported.</p></blockquote><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="delete-template"></a>Delete template<a class="hash-link" href="#delete-template" title="Direct link to heading">#</a></h3><p><code>GET /api/v1/template/{name}</code></p><p><strong>Example Request:</strong></p><div class="mdxCodeBlock_1zKU"><div class="codeBlockContent_actS"><div tabindex="0" class="prism-code language-sh 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">curl -X DELETE http://127.0.0.1:32080/api/v1/template/my-tf-mnist-template</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2GIj">Copy</button></div></div><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="use-template-to-create-a-experiment"></a>Use template to create a experiment<a class="hash-link" href="#use-template-to-create-a-experiment" title="Direct link to heading">#</a></h3><p><code>POST /api/v1/experiment/{template_name}</code></p><p><strong>Example Request:</strong></p><div class="mdxCodeBlock_1zKU"><div class="codeBlockContent_actS"><div tabindex="0" class="prism-code language-sh 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">curl -X POST -H "Content-Type: application/json" -d '</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">{</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "name": "tf-mnist",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "params": {</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "learning_rate":"0.01",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "batch_size":"150",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "experiment_name":"newexperiment1"</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">}</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">' http://127.0.0.1:32080/api/v1/experiment/my-tf-mnist-template</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2GIj">Copy</button></div></div></div></article><div class="margin-vert--xl"><div class="row"><div class="col"><a href="https://github.com/apache/submarine/edit/master/website/versioned_docs/version-0.6.0/api/experiment-template.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/api/experiment"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">« Experiment REST API</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/docs/api/notebook"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Notebook REST API »</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="#create-experiment-template" class="table-of-contents__link">Create experiment template</a><ul><li><a href="#list-experiment-template" class="table-of-contents__link">List experiment template</a></li><li><a href="#get-experiment-template" class="table-of-contents__link">Get experiment template</a></li><li><a href="#patch-template" class="table-of-contents__link">Patch template</a></li><li><a href="#delete-template" class="table-of-contents__link">Delete template</a></li><li><a href="#use-template-to-create-a-experiment" class="table-of-contents__link">Use template to create a experiment</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/gettingStarted/quickstart">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="margin-bottom--sm"><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer" class="footerLogoLink_31Aa"><img class="footer__logo" alt="Apache Open Source Logo" src="https://hadoop.apache.org/asf_logo_wide.png"></a></div><div class="footer__copyright">Apache Submarine, Submarine, Apache, the Apache feather logo, and the Apache Submarine project logo are |
| either registered trademarks or trademarks of the Apache Software Foundation in the United States and other |
| countries.<br> Copyright © 2022 Apache Submarine is Apache2 Licensed software.</div></div></div></footer></div> |
| <script src="/styles.6ddab7ad.js"></script> |
| <script src="/runtime~main.943b9f3a.js"></script> |
| <script src="/main.92db4fb0.js"></script> |
| <script src="/1.dab80c77.js"></script> |
| <script src="/2.6a1a8326.js"></script> |
| <script src="/1f391b9e.f22e8160.js"></script> |
| <script src="/128.10c43f42.js"></script> |
| <script src="/58f10d9f.87a860a5.js"></script> |
| <script src="/17896441.be8f95bf.js"></script> |
| <script src="/f6956115.1f3df0b9.js"></script> |
| </body> |
| </html> |
