| (window.webpackJsonp=window.webpackJsonp||[]).push([[64],{131:function(e,n,t){"use strict";t.r(n),t.d(n,"frontMatter",(function(){return o})),t.d(n,"metadata",(function(){return l})),t.d(n,"toc",(function(){return i})),t.d(n,"default",(function(){return p}));var r=t(3),a=t(7),s=(t(0),t(193)),o={title:"Serve REST API"},l={unversionedId:"api/model-version",id:"api/model-version",isDocsHomePage:!1,title:"Serve REST API",description:"\x3c!--",source:"@site/docs/api/model-version.md",slug:"/api/model-version",permalink:"/docs/next/api/model-version",editUrl:"https://github.com/apache/submarine/edit/master/website/docs/api/model-version.md",version:"current"},i=[{value:"List model versions under a registered model",id:"list-model-versions-under-a-registered-model",children:[]},{value:"Get a model version",id:"get-a-model-version",children:[]},{value:"Patch a model version",id:"patch-a-model-version",children:[]},{value:"Delete a model version",id:"delete-a-model-version",children:[]},{value:"Create a model version tag",id:"create-a-model-version-tag",children:[]},{value:"Delete a model version tag",id:"delete-a-model-version-tag",children:[]}],c={toc:i};function p(e){var n=e.components,t=Object(a.a)(e,["components"]);return Object(s.b)("wrapper",Object(r.a)({},c,t,{components:n,mdxType:"MDXLayout"}),Object(s.b)("blockquote",null,Object(s.b)("p",{parentName:"blockquote"},"Note: The Model Version API is in the alpha stage which is subjected to incompatible changes in future releases.")),Object(s.b)("h3",{id:"list-model-versions-under-a-registered-model"},"List model versions under a registered model"),Object(s.b)("p",null,Object(s.b)("inlineCode",{parentName:"p"},"GET /api/v1/model-version/{name}")),Object(s.b)("p",null,Object(s.b)("strong",{parentName:"p"},"Example Request:")),Object(s.b)("pre",null,Object(s.b)("code",{parentName:"pre",className:"language-sh"},"curl -X GET http://127.0.0.1:32080/api/v1/model-version/register\n")),Object(s.b)("p",null,Object(s.b)("strong",{parentName:"p"},"Example Response:")),Object(s.b)("pre",null,Object(s.b)("code",{parentName:"pre",className:"language-json"},'{\n "attributes" : {},\n "code" : 200,\n "message" : "List all model version instances",\n "result" : [\n {\n "creationTime" : "2021-12-12 02:27:05",\n "currentStage" : "None",\n "dataset" : null,\n "description" : null,\n "experimentId" : "experiment-1639276018590-0001",\n "lastUpdatedTime" : "2021-12-12 02:27:05",\n "modelType" : "tensorflow",\n "name" : "register",\n "source" : "s3://submarine/experiment-1639276018590-0001/example/1",\n "tags" : [],\n "userId" : "",\n "version" : 1\n },\n {\n "creationTime" : "2021-12-12 02:27:05",\n "currentStage" : "None",\n "dataset" : null,\n "description" : null,\n "experimentId" : "experiment-1639276018590-0001",\n "lastUpdatedTime" : "2021-12-12 02:27:05",\n "modelType" : "tensorflow",\n "name" : "register",\n "source" : "s3://submarine/experiment-1639276018590-0001/example/2",\n "tags" : [],\n "userId" : "",\n "version" : 2\n },\n {\n "creationTime" : "2021-12-12 02:27:05",\n "currentStage" : "None",\n "dataset" : null,\n "description" : null,\n "experimentId" : "experiment-1639276018590-0001",\n "lastUpdatedTime" : "2021-12-12 02:27:05",\n "modelType" : "tensorflow",\n "name" : "register",\n "source" : "s3://submarine/experiment-1639276018590-0001/example1/1",\n "tags" : [],\n "userId" : "",\n "version" : 3\n },\n {\n "creationTime" : "2021-12-12 02:27:06",\n "currentStage" : "None",\n "dataset" : null,\n "description" : null,\n "experimentId" : "experiment-1639276018590-0001",\n "lastUpdatedTime" : "2021-12-12 02:27:06",\n "modelType" : "tensorflow",\n "name" : "register",\n "source" : "s3://submarine/experiment-1639276018590-0001/example2/1",\n "tags" : [],\n "userId" : "",\n "version" : 4\n },\n ],\n "status" : "OK",\n "success" : true\n}\n')),Object(s.b)("h3",{id:"get-a-model-version"},"Get a model version"),Object(s.b)("p",null,Object(s.b)("inlineCode",{parentName:"p"},"GET /api/v1/model-version/{name}/{version}")),Object(s.b)("p",null,Object(s.b)("strong",{parentName:"p"},"Example Request:")),Object(s.b)("pre",null,Object(s.b)("code",{parentName:"pre",className:"language-sh"},"curl -X GET http://127.0.0.1:32080/api/v1/model-version/register/1\n")),Object(s.b)("p",null,Object(s.b)("strong",{parentName:"p"},"Example Response:")),Object(s.b)("pre",null,Object(s.b)("code",{parentName:"pre",className:"language-json"},'{\n "attributes" : {},\n "code" : 200,\n "message" : "Get the model version instance",\n "result" : {\n "creationTime" : "2021-12-12 02:27:05",\n "currentStage" : "None",\n "dataset" : null,\n "description" : null,\n "experimentId" : "experiment-1639276018590-0001",\n "lastUpdatedTime" : "2021-12-12 02:27:05",\n "modelType" : "tensorflow",\n "name" : "register",\n "source" : "s3://submarine/experiment-1639276018590-0001/example/1",\n "tags" : [],\n "userId" : "",\n "version" : 1\n },\n "status" : "OK",\n "success" : true\n}\n')),Object(s.b)("h3",{id:"patch-a-model-version"},"Patch a model version"),Object(s.b)("p",null,Object(s.b)("inlineCode",{parentName:"p"},"PATCH /api/v1/model-version")),Object(s.b)("p",null,Object(s.b)("strong",{parentName:"p"},"Example Request:")),Object(s.b)("pre",null,Object(s.b)("code",{parentName:"pre",className:"language-sh"},'curl -X PATCH -H "Content-Type: application/json" -d \'\n{\n "name": "register",\n "version": 1,\n "description": "new_description",\n "currentStage": "production",\n "dataset": "new_dataset"\n}\' http://127.0.0.1:32080/api/v1/model-version\n')),Object(s.b)("p",null,Object(s.b)("strong",{parentName:"p"},"Example Response:")),Object(s.b)("pre",null,Object(s.b)("code",{parentName:"pre",className:"language-json"},'{\n "attributes" : {},\n "code" : 200,\n "message" : "Update the model version instance",\n "result" : null,\n "status" : "OK",\n "success" : true\n}\n')),Object(s.b)("h2",{id:"delete-a-model-version"},"Delete a model version"),Object(s.b)("p",null,Object(s.b)("inlineCode",{parentName:"p"},"DELETE /api/v1/model-version/{name}/{version}")),Object(s.b)("p",null,Object(s.b)("strong",{parentName:"p"},"Example Request")),Object(s.b)("pre",null,Object(s.b)("code",{parentName:"pre",className:"language-sh"},"curl -X DELETE http://127.0.0.1:32080/api/v1/model-version/register/1\n")),Object(s.b)("p",null,Object(s.b)("strong",{parentName:"p"},"Example Response:")),Object(s.b)("pre",null,Object(s.b)("code",{parentName:"pre",className:"language-json"},'{\n "attributes" : {},\n "code" : 200,\n "message" : "Delete the model version instance",\n "result" : null,\n "status" : "OK",\n "success" : true\n}\n')),Object(s.b)("h2",{id:"create-a-model-version-tag"},"Create a model version tag"),Object(s.b)("p",null,Object(s.b)("inlineCode",{parentName:"p"},"POST /api/v1/model-version/tag?name={name}&version={version}&tag={tag}")),Object(s.b)("p",null,Object(s.b)("strong",{parentName:"p"},"Example Request")),Object(s.b)("pre",null,Object(s.b)("code",{parentName:"pre",className:"language-sh"},"curl -X POST http://127.0.0.1:32080/api/v1/model-version/tag?name=register&version=2&tag=789\n")),Object(s.b)("p",null,Object(s.b)("strong",{parentName:"p"},"Example Response:")),Object(s.b)("pre",null,Object(s.b)("code",{parentName:"pre",className:"language-json"},'{\n "attributes" : {},\n "code" : 200,\n "message" : "Create a model version tag instance",\n "result" : null,\n "status" : "OK",\n "success" : true\n}\n')),Object(s.b)("h2",{id:"delete-a-model-version-tag"},"Delete a model version tag"),Object(s.b)("p",null,Object(s.b)("inlineCode",{parentName:"p"},"DELETE /api/v1/model-version/tag?name={name}&version={version}&tag={tag}")),Object(s.b)("p",null,Object(s.b)("strong",{parentName:"p"},"Example Request")),Object(s.b)("pre",null,Object(s.b)("code",{parentName:"pre",className:"language-sh"},"curl -X DELETE http://127.0.0.1:32080/api/v1/model-version/tag?name=register&version=2&tag=789\n")),Object(s.b)("p",null,Object(s.b)("strong",{parentName:"p"},"Example Response:")),Object(s.b)("pre",null,Object(s.b)("code",{parentName:"pre",className:"language-json"},'{\n "status":"OK",\n "code":200,\n "success":true,\n "message":"Delete a registered model tag instance",\n "result":null,\n "attributes":{}\n}\n')))}p.isMDXComponent=!0},193:function(e,n,t){"use strict";t.d(n,"a",(function(){return m})),t.d(n,"b",(function(){return b}));var r=t(0),a=t.n(r);function s(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function o(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function l(e){for(var n=1;n<arguments.length;n++){var t=null!=arguments[n]?arguments[n]:{};n%2?o(Object(t),!0).forEach((function(n){s(e,n,t[n])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):o(Object(t)).forEach((function(n){Object.defineProperty(e,n,Object.getOwnPropertyDescriptor(t,n))}))}return e}function i(e,n){if(null==e)return{};var t,r,a=function(e,n){if(null==e)return{};var t,r,a={},s=Object.keys(e);for(r=0;r<s.length;r++)t=s[r],n.indexOf(t)>=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(r=0;r<s.length;r++)t=s[r],n.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var c=a.a.createContext({}),p=function(e){var n=a.a.useContext(c),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},m=function(e){var n=p(e.components);return a.a.createElement(c.Provider,{value:n},e.children)},u={inlineCode:"code",wrapper:function(e){var n=e.children;return a.a.createElement(a.a.Fragment,{},n)}},d=a.a.forwardRef((function(e,n){var t=e.components,r=e.mdxType,s=e.originalType,o=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),m=p(t),d=r,b=m["".concat(o,".").concat(d)]||m[d]||u[d]||s;return t?a.a.createElement(b,l(l({ref:n},c),{},{components:t})):a.a.createElement(b,l({ref:n},c))}));function b(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var s=t.length,o=new Array(s);o[0]=d;var l={};for(var i in n)hasOwnProperty.call(n,i)&&(l[i]=n[i]);l.originalType=e,l.mdxType="string"==typeof e?e:r,o[1]=l;for(var c=2;c<s;c++)o[c]=t[c];return a.a.createElement.apply(null,o)}return a.a.createElement.apply(null,t)}d.displayName="MDXCreateElement"}}]); |