MLSteam Model SDK
Project description
mlsteam-model-sdk
SDK for accessing MLSteam models
Setup
pip3 install mlsteam-model-sdk
To process encrypted model versions, install the Themis development package according to the official instrunctions. Debian/Ubuntu users have a handy installation method:
# for users that already have administrator privileges
mlsteam-model-cli install-themisdev
# for those that need privilege lifting
sudo mlsteam-model-cli install-themisdev
Usage
Initilize SDK
SDK needs to be initialized if you have not done so (replace the fields started with $):
mlsteam-model-cli init \
--default_project_type=name \
--default_project_val=$PROJECT_OWNER/$PROJECT_NAME
By default, the settings will be at
$HOME/.mlsteam-model-sdk/cfg.ini
.
If the program is running out of an MLSteam system, you may also need to setup api_token
with this command instead, or by editing the api_token field in cfg.ini
:
mlsteam-model-cli init \
--api_token=$YOUR_API_TOKEN \
--default_project_type=name \
--default_project_val=$PROJECT_OWNER/$PROJECT_NAME
Downloading a model version with SDK
from mlsteam_model_sdk.sdk.model import Model
sdk_model = Model()
sdk_model.download_model_version(model_name='model_name',
version_name='version_name')
You will need administrator privileges to handle encrypted model versions. For this case, either run the Python program with
sudo
, or enter your password in asudo
prompt during program execution. Administrator privileges are not required when you only process non-encrypted model versions.
By default, the model version will be downloaded at
$HOME/.mlsteam-model-sdk/models/download/
.
This loads a model version and makes prediction:
mv = sdk_model.load_model_version(model_name='model_name',
version_name='version_name')
outputs = mv.predict(inputs)
Importing a model version with CLI
This example assumes the following files are locally available:
- model version package (required)
- package encryption key (required only for encrypted packages)
You will need administrator privileges to import an encrypted model version, as mentioned in the previous example.
To import a package:
# for non-encrypted packages
mlsteam-model-cli mv import-local -f $PACKAGE_FILE_PATH
# for encrypted packages
mlsteam-model-cli mv import-local -f $PACKAGE_FILE_PATH -k $ENCKEY_FILE_PATH
By default, the model and version names to register are read from the package manifest. You may customize these settings with the
--model_name
and--version_name
options.
If the operation is successful, you will find the imported pakage in local model registry:
mlsteam-model-cli mv list-local
muuid model_name vuuid version_name puuid packaged encrypted download_time ================================================================================================================ __local__ ... local-........ ... __local__ 1 ... .....
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
Hashes for mlsteam_model_sdk-0.4.3-cp311-none-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 32f9eca862ae130f044c49d9a7723026d45324e1cfb163852d1166db48c4a8ff |
|
MD5 | 46074262619b5d9261ab397d4218e15e |
|
BLAKE2b-256 | 5eec51185c5b17b0e5a019541dced1778de0743da356d4e5141f5a30955567a1 |
Hashes for mlsteam_model_sdk-0.4.3-cp310-none-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fdd932124a9d343623e4635a374515c090efd8fd20ffc9893b3dfc8c56abb6f8 |
|
MD5 | 33f957406bdfbfac7914dcd7ef275621 |
|
BLAKE2b-256 | f7cae9e938a3bf74b04d4d84913df481cceb3f655aecfdbcba171b03fe3ad6eb |
Hashes for mlsteam_model_sdk-0.4.3-cp39-none-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 382414ff06cca1b37cf6f6886d185cf2e6c6fc3f17417a66ef6978c040782921 |
|
MD5 | 234f602d78692f559a64545faf0855f0 |
|
BLAKE2b-256 | 0c9347e1ccd0dd35111a62601fba085f54fa7de90c9e91f3aaedccd8d29f6e16 |
Hashes for mlsteam_model_sdk-0.4.3-cp38-none-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 606a330084f1a10ed226197e35186fb214e108bbdab343e8d79004b24df35d53 |
|
MD5 | a19654c34e8f9c741886dfc071cbe351 |
|
BLAKE2b-256 | a3ab9f955af24372cb52da9fb9b34806bcf760d1d54762152f75c3c1f15786a5 |
Hashes for mlsteam_model_sdk-0.4.3-cp37-none-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f47aff4ab55ede2a12bbcb09ff48bfcad835f70c7ef4cd10b53eb5edd5082daa |
|
MD5 | d8f3ec54e06f04b3332e9de209958296 |
|
BLAKE2b-256 | e407f572cfdde95fbe27dbc2d13de211b41ec122919a4235b81cdd4865fd4535 |
Hashes for mlsteam_model_sdk-0.4.3-cp36-none-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aa6e27041199a9450fffc41bd456fca669caf1f508365c5aff61a118963d1f28 |
|
MD5 | 8aaf38d51d17007a2ef3af98139174d1 |
|
BLAKE2b-256 | e03d50d6cde511a8a8496e439941ea99354f6a9db04968ed65e9ebd021e0692a |