Skip to main content

Ml-Board Client Library

Project description

# python-mlboardclient

Python lib for interacting ml-board component.

## Installation

```bash
pip install 'git+https://github.com/kuberlab/python-mlboardclient.git'
```

## Usage

```python
from mlboardclient.api import client

# Default url is http://mlboard-v2.kuberlab:8082/api/v2
# No need to pass any url if instantiate client from ml-project (Jupyter/Task)
ml = client.Client()
apps = ml.apps.list()
[<mlboardclient.api.v2.apps.App object at 0x7f0b554b5f90>]

app = apps[0]
# Get tasks from config
app.tasks
[<Task name=model build=None status=undefined>]

task = app.tasks[0]

# Run & wait task
task.run()
<Task name=model build=4 status=Succeeded>

# Get tasks from API
app.get_tasks()
[<Task name=model build=1 status=Failed>, <Task name=model build=2 status=Failed>,
<Task name=model build=3 status=Failed>, <Task name=model build=4 status=Succeeded>]
```

### Model upload

```python
ml.model_upload('my-model', '1.0.0', '/model/dir')
# If the model uploading is not executing in scope of project task,
# need to specify workspace_name and project_name explicitly:
ml.model_upload(
'my-model',
'1.0.0',
'/model/dir',
workspace_name='demo',
project_name='test-project
)

# Wait until model is being uploaded.
```



Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

python_mlboardclient-1.0.0-py2.py3-none-any.whl (16.8 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page