Neuromation Platform API client
Project description
Welcome to Neuromation API Python client
Hello World
from neuromation import model, storage
# Authentication information is retrieved from environment
# variables or from ~/.neuromation
# Upload training dataset
#
# Option 1. Use stream as source and write it
# to file in Neuromation object storage
#
# TODO: if file exists, shall we throw or overwrite?
uri = storage.upload(
source=open('file://~/local/file', 'rb'),
destination='storage://~/hello_world_data/file')
# Option 2. Use local file or directory and copy it
# similar to cp -r
#
# TODO: support for globs?
uri = storage.upload(
source='file://~/local/',
destination='storage://~/hello_world_data/')
# Train using container image from neuromation repo
# and use a newly uploaded dataset
#
# status is a handle that contains job id and allows to:
# 1. query training process
# 2. wait for job to complete (via await)
# 3. subscribe to job completion by passing handle
# 4. retrieve job results. In case of training it is the uri
# for model checkpoint that is passed in results argument
# or auto-generated if results not specified or None (default)
# 5. Future: stop, pause, resume job
training_job = model.train(
image='neuromation/hello-world',
resources=model.Resources(memory='64G', cpu=4, gpu=4),
dataset=uri,
results='storage://~/hello-world/model')
# Wait for job to complete and retrieve weights uri
model_uri = training_job.wait().uri
# Upload dataset for inference from client's local file system
#
dataset_uri = storage.upload(
source='file://~/local/dataset',
destination='storage://~/hello_world_data/dataset')
# Run inference on newly trained model
inference_job = model.infer(
image='neuromation/hello-world',
resources=model.Resources(memory='16G', cpu=2, gpu=1)
model=model_uri,
dataset=dataset_uri,
cmd='arg1' # Optional
)
# Wait for job to complete and retrieve result set uri
results_uri = inference_job.wait().uri
# Download result set
storage.download(
source=results_uri,
destination='file://~/local/results')
Errors(Exceptions)
- ClientError
- IllegalArgumentError!!!(bultins.ValueError)
- ResourceNotFoundError
- AuthError
- AuthenticationError
- AuthorizationError
Contributing
git clone https://github.com/neuromation/platform-api-clients.git
cd platform-api-clients/python
Before you begin, it is recommended to have clean virtual environment installed:
python -m venv .env
source .env/bin/activate
Development flow:
- Install dependencies:
make init - Run tests:
make test - Lint:
make lint - Publish to pypi:
make publish
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
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for neuromation-0.1.5b0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0b27523875646558a3dd9f432e4c9f41a15b89ef29eee73f95fd10b23fdd8c9a |
|
| MD5 | d6e9e0c4c23272994a1097db7444593c |
|
| BLAKE2b-256 | 28bfdf5161065ffc64ae944276b0a5a83ac69175eb3bed5435fe16920fd59f4e |
