Try   HackMD

MLServe Api Document

tags: mlserve apidoc

Admin api

Tritons

GET /api/tritons List tritons
Title apiTritonList
URL /api/tritons
Method GET

Request

Response

{ "tritons":[ { "name": str, "host": str, "port": str, "gpus": int, "state" str, "create_at": Date }, ] }

Response Now

{ "tritons":[ { "id": int, "ip": str, "port": str, "gpus": int, "models" [], "path": str, }, ] }
POST /api/tritons Create tritons
Title apiTritonCreate
URL /api/tritons
Method POST

Request

{ "name": str, "host": str, "port": str, "gpus": int }

Request Now

{ "ip": str, "port": str, }

Response

{ "name": str, "host": str, "port": str, "gpus": int, "state" str, "create_at": Date }

Response Now

{ "id": int }
GET /api/tritons/$ Get triton
Title apiTritonGet
URL /api/tritons/${ideneity}
Method GET

Request

Response

{ "name": str, "host": str, "port": str, "gpus": int, "state" str, "create_at": Date }

Response Now

{ "data": { "id": int, "ip": str, "port": str, "gpus": int, "models" [], "path": str, } }
PATCH /api/tritons/$ Update triton
Title apiTritonUpdate
URL /api/tritons/${ideneity}
Method PATCH

Request

{ "name": str, "host": str, "port": str, "gpus": int }

Request Now

{ "ip": str, "port": str, }

Response

{ "name": str, "host": str, "port": str, "gpus": int, "state" str, "create_at": Date }

Response Now

{ "status": "ok" }
DELETE /api/tritons/$ Delete triton
Title apiTritonDelete
URL /api/tritons/${ideneity}
Method DELETE

Request

Response

{ "status": "ok" }

Models

GET /api/models List models
Title apiModelList
URL /api/models
Method GET

Request

Response

{ "models":[ { "name": str, "latest_version": str, "inference_count": str, "last_inference": Date, "state" str, "create_at": Date }, ] }

Response Now

{ "id": int, "name": str, "path": str, "versions": PickleType, "tritons": [ "ip": str, "port": str ] }
POST /api/models Create model
Title apiModelCreate
URL /api/models
Method POST

Request

{ "name": str, "files[]": File[], }

Response

{ "name": str, "latest_version": str, "inference_count": str, "last_inference": Date, "state" str, "create_at": Date }

Response Now

{ "id": int }
GET /api/models/$ Get model
Title apiModelGet
URL /api/models/${identity}
Method GET

Request

{ }

Request Now

{ "triton_id": str }

Response

{ "name": str, "latest_version": str, "inference_count": str, "last_inference": Date, "state" str, "versions": [ { "version": str, "inference_count": str, "execution_count": str, "last_inference": Date, "state" str, }, ] "create_at": Date }

Response Now

{ "config": { "localhost:8080": { "name":"resnet50_netdef", "versions" :["1","2"], "platform":"caffe2_netdef", "inputs":[ { "name":"gpu_0/data","datatype":"FP32","shape":[-1,3,224,224] } ], "outputs":[ { "name":"gpu_0/softmax","datatype":"FP32","shape":[-1,1000] } ] } } }
PATCH /api/models/$ Update model
Title apiModelGet
URL /api/models/${identity}
Method PATCH

Request

{ "description": str }

Request Now

{ "Files[]": File }

Response

{ "status": "ok" }
DELETE /api/models/$ Delete model
Title apiModelDelete
URL /api/models/${identity}
Method DELETE

Request

Response

{ "status": "ok" }
POST /api/models/$/load Load model
Title apiModelLoad
URL /api/models/${identity}/load
Method POST

Request

Request Now

{ "triton_id": str }

Response

{ "status": "ok" }
POST /api/models/$ Unload model
Title apiModelUnload
URL /api/models/${identity}/unload
Method POST

Request

Request Now

{ "triton_id": str }

Response

{ "status": "ok" }
GET /api/models/$/versions List model-version
Title apiModelVersionList
URL /api/models/${identity}/versions
Method GET

Request

Response

{ "versions": [ { "version": str, "inference_count": str, "execution_count": str, "last_inference": Date, "state" str, }, ] }

Response Now

{ "versions": PickleType }
POST /api/models/$/versions Upgrade model-version
Title apiModelVersionCreate
URL /api/models/${identity}/versions
Method POST

Request

{ "Files[]": Files[], "offset": str, "check": str }

Response

{ "status": "ok" }
DELETE /api/models/$/versions Delete model-version
Title apiModelVersionDelete
URL /api/models/${identity}/versions
Method DELETE

Request

Response

{ "status": "ok" }

Users

GET /api/users List Users
Title apiUserList
URL /api/users
Method GET

Request

Response

{ "users": [ { "name": str, "password": str, "role": str, "tags": str, "apps": [ str ] } ] }
POST /api/users Create User
Title apiUserCreate
URL /api/users
Method POST

Request

{ "name": str, "password": str, "role": str, "tags": str }

Response

{ "status": "ok" }
GET /api/users/$ Get User
Title apiUserGet
URL /api/users/${identity}
Method GET

Request

{ "name": str, "password": str, "role": str, "tags": str }

Response

{ "name": str, "password": str, "role": str, "tags": str, "apps": [ str ] }
DELETE /api/users/$ Delete User
Title apiUserDelete
URL /api/users/${identity}
Method DELETE

Request

Response

{ "status": "ok" }
PATCH /api/users/$ Update User
Title apiUserUpdate
URL /api/users/${identity}
Method PATCH

Request

{ "password": str, "role": str, "tags": str }

Response

{ "status": "ok" }
GET /api/users/$/apps List User Apps
Title apiiUserAppList
URL /api/users/${identity}/apps
Method GET

Request

Response

{ "apps": [str] }
POST /api/users/$/apps/${app}/auth Auth User App
Title apiUserAppAuth
URL /api/users/${identity}/apps/${app}/auth
Method POST

Request

Response

{ "status": "ok" }
POST /api/users/$/apps/${app}/unauth Unauth User App
Title apiUserAppUnauth
URL /api/users/${identity}/apps/${app}/unauth
Method POST

Request

Response

{ "status": "ok" }

Applications

GET /api/apps List Applications
Title apiAppList
URL /api/apps
Method GET

Request

Response

{ "apps": [ { "name": str, "host": str, "port": str, "retries": str, "routes": [ { "model_name": str, "protocols": [str], "url": str, "paths": [str], "create_at": Date }, ], "consumers": [ { "name": str, "tags": str, "cteate_at": Date }, ], "update_at": Date, "create_at": Date }, ] }
POST /api/apps Create Application
Title apiAppCreate
URL /api/apps
Method POST

Request

{ "name": str, "host": str, "ip": str, "gpus": int, // Fix 1 now "retries": int }

Response

{ "name": str, "host": str, "ip": str, "gpus": int, "retries": int, "update_at": Date, "create_at": Date }
GET /api/apps/ Get Application
Title apiAppGet
URL /api/apps/${identity}
Method GET

Request

Response

{ "name": str, "host": str, "ip": str, "gpus": int, "retries": int "routes": [ { "model_name": str, "protocols": [str], "url": str, "paths": [str], "create_at": Date }, ], "consumers": [ { "name": str, "tags": str, "cteate_at": Date }, ], "update_at": Date, "create_at": Date }
PATCH /api/apps/$ Update Application
Title apiAppUpdate
URL /api/apps/${identity}
Method PATCH

Request

{ "name": str, "host": str, "ip": str, "gpus": int, // Fix 1 now "retries": int }

Response

{ "name": str, "host": str, "ip": str, "gpus": int, "retries": int "update_at": Date, "create_at": Date }
DELETE /api/apps/$ Delete Application
Title apiAppDelete
URL /api/apps/${identity}
Method DELETE

Request

Response

{ "status": "ok" }
GET /api/apps/$/routes Get models from Application
Title apiAppRoutesList
URL /api/apps/${identity}/routes
Method GET

Request

Response

{ "routes": [ { "model_name": str, "protocols": [str], "url": str, "paths": [str], "create_at": Date }, ] }
POST /api/apps/$/routes/${model} Import model to Application
Title apiAppRoutesImport
URL /api/apps/${identity}/routes/${model}
Method POST

Request

Response

{ "status": "ok" }
DELETE /api/apps/$/routes/${model} Remove model from Application
Title apiAppRoutesRemove
URL /api/apps/${identity}/routes/${model}
Method DELETE

Request

Response

{ "status": "ok" }
GET /api/apps/$/consumers Get consumers from Application
Title apiAppConsumersList
URL /api/apps/${identity}/consumers
Method GET

Request

Response

{ "consumers": [ { "name": str, "tags": str, "cteate_at": Date }, ], }
POST /api/apps/$/consumers/${consumer} Add consumer to Application
Title apiAppConsumersAdd
URL /api/apps/${identity}/consumers/${consumer}
Method POST

Request

Response

{ "status": "ok" }
DELETE /api/apps/$/routes/${consumer} Remove consumer from Application
Title apiAppConsumersRemove
URL /api/apps/${identity}/consumers/${consumer}
Method DELETE

Request

Response

{ "status": "ok" }

Developer api