Table of Contents

• Preface
• neuro
  • neuro completion
    • neuro completion generate
    • neuro completion patch
  • neuro config
    • neuro config auth
    • neuro config forget
    • neuro config id_rsa
    • neuro config show
    • neuro config show-token
    • neuro config url
  • neuro help
  • neuro image
    • neuro image ls
    • neuro image pull
    • neuro image push
  • neuro job
    • neuro job exec
    • neuro job kill
    • neuro job list
    • neuro job monitor
    • neuro job ssh
    • neuro job status
    • neuro job submit
    • neuro job top
  • neuro login
  • neuro logout
  • neuro model
    • neuro model debug
    • neuro model train
  • neuro share
  • neuro storage
    • neuro storage cp
    • neuro storage ls
    • neuro storage mkdir
    • neuro storage mv
    • neuro storage rm
  • neuro store
    • neuro store cp
    • neuro store ls
    • neuro store mkdir
    • neuro store mv
    • neuro store rm
• Api
• Contributing

Preface

Welcome to Neuromation API Python client. Package ship command line tool called neuro. With neuro you can:

• Execute and debug jobs
• Manipulate Data
• Make some fun

neuro

▇ ◣
▇ ◥ ◣
◣ ◥ ▇
▇ ◣ ▇
▇ ◥ ◣ ▇
▇ ◥ ▇ Neuromation Platform
▇ ◣ ◥
◥ ◣ ▇ Deep network training,
◥ ▇ inference and datasets
◥

Usage:

neuro [OPTIONS] COMMAND [ARGS]...

Options:

Commands:

• neuro completion: Generates code to enable shell-completion.

• neuro config: Client configuration settings commands.

• neuro help: Get help on a command

• neuro image: Docker image operations

• neuro job: Job operations.

• neuro login: Log into Neuromation Platform.

• neuro logout: Log out.

• neuro model: Model operations.

• neuro share: Shares resource specified by URI to a USER with PERMISSION

• neuro storage: Storage operations.

• neuro store: Alias for storage (DEPRECATED)

neuro completion

Generates code to enable shell-completion.

Usage:

neuro completion [OPTIONS] COMMAND [ARGS]...

Options:

Commands:

• neuro completion generate: Provide an instruction for shell completion generation.
• neuro completion patch: Automatically patch shell configuration profile to enable completion

neuro completion generate

Provide an instruction for shell completion generation.

Usage:

neuro completion generate [OPTIONS]

Options:

neuro completion patch

Automatically patch shell configuration profile to enable completion

Usage:

neuro completion patch [OPTIONS]

Options:

neuro config

Client configuration settings commands.

Usage:

neuro config [OPTIONS] COMMAND [ARGS]...

Options:

Commands:

• neuro config auth: Update authorization token.
• neuro config forget: Forget authorization token. (DEPRECATED)
• neuro config id_rsa: Update path to id_rsa file with private key.

FILE is being used for accessing remote shell, remote debug.

Note: this is temporal and going to be replaced in future by JWT token.

• neuro config show: Print current settings.
• neuro config show-token: Print current authorization token.
• neuro config url: Update settings with provided platform URL.

neuro config auth

Update authorization token.

Usage:

neuro config auth [OPTIONS] TOKEN

Options:

neuro config forget

Forget authorization token. (DEPRECATED)

Usage:

neuro config forget [OPTIONS]

Options:

neuro config id_rsa

Update path to id_rsa file with private key.

FILE is being used for accessing remote shell, remote debug.

Note: this is temporal and going to be replaced in future by JWT token.

Usage:

neuro config id_rsa [OPTIONS] FILE

Options:

neuro config show

Print current settings.

Usage:

neuro config show [OPTIONS]

Options:

neuro config show-token

Print current authorization token.

Usage:

neuro config show-token [OPTIONS]

Options:

neuro config url

Update settings with provided platform URL.

Usage:

neuro config url [OPTIONS] URL

Examples:

neuro config url https://platform.neuromation.io/api/v1

Options:

neuro help

Get help on a command

Usage:

neuro help [OPTIONS] [COMMAND]...

Options:

neuro image

Docker image operations

Usage:

neuro image [OPTIONS] COMMAND [ARGS]...

Options:

Commands:

• neuro image ls: List user's images which are available for jobs.

You will see here own and shared with you images

• neuro image pull: Pull an image from platform registry.

Remote image name must be URL with image:// scheme. Image names can contain tag.

• neuro image push: Push an image to platform registry.

Remote image must be URL with image:// scheme. Image names can contains tag. If tags not specified 'latest' will be used as value.

neuro image ls

List user's images which are available for jobs.

You will see here own and shared with you images

Usage:

neuro image ls [OPTIONS]

Options:

neuro image pull

Pull an image from platform registry.

Remote image name must be URL with image:// scheme. Image names can contain
tag.

Usage:

neuro image pull [OPTIONS] IMAGE_NAME [LOCAL_IMAGE_NAME]

Examples:

neuro image pull image:myimage
neuro image pull image://myfriend/alpine:shared
neuro image pull image://username/my-alpine:production alpine:from-registry

Options:

neuro image push

Push an image to platform registry.

Remote image must be URL with image:// scheme. Image names can contains tag.
If tags not specified 'latest' will be used as value.

Usage:

neuro image push [OPTIONS] IMAGE_NAME [REMOTE_IMAGE_NAME]

Examples:

neuro image push myimage
neuro image push alpine:latest image:my-alpine:production
neuro image push alpine image://myfriend/alpine:shared

Options:

neuro job

Job operations.

Usage:

neuro job [OPTIONS] COMMAND [ARGS]...

Options:

Commands:

• neuro job exec: Executes command in a running job.

• neuro job kill: Kill job(s)

• neuro job list: List all jobs.

• neuro job monitor: Monitor job output stream

• neuro job ssh: Starts ssh terminal connected to running job. Job should be started with SSH support enabled.

• neuro job status: Display status of a job

• neuro job submit: Start job using IMAGE.

COMMANDS list will be passed as commands to model container.

• neuro job top: Display real-time job telemetry

neuro job exec

Executes command in a running job.

Usage:

neuro job exec [OPTIONS] ID CMD...

Options:

neuro job kill

Kill job(s)

Usage:

neuro job kill [OPTIONS] ID...

Options:

neuro job list

List all jobs.

Usage:

neuro job list [OPTIONS]

Examples:

neuro job list --description="my favourite job"
neuro job list --status=all
neuro job list -s pending -s running -q

Options:

neuro job monitor

Monitor job output stream

Usage:

neuro job monitor [OPTIONS] ID

Options:

neuro job ssh

Starts ssh terminal connected to running job. Job should be started with SSH
support enabled.

Usage:

neuro job ssh [OPTIONS] ID

Examples:

neuro job ssh --user alfa --key ./my_docker_id_rsa job-abc-def-ghk

Options:

neuro job status

Display status of a job

Usage:

neuro job status [OPTIONS] ID

Options:

neuro job submit

Start job using IMAGE.

COMMANDS list will be passed as commands to model container.

Usage:

neuro job submit [OPTIONS] IMAGE [CMD]...

Examples:

# Starts a container pytorch:latest with two paths mounted. Directory /q1/
# is mounted in read only mode to /qm directory within container.
# Directory /mod mounted to /mod directory in read-write mode.
neuro job submit --volume storage:/q1:/qm:ro --volume storage:/mod:/mod:rw     pytorch:latest

# Starts a container pytorch:latest with connection enabled to port 22 and
# sets PYTHONPATH environment value to /python.
# Please note that SSH server should be provided by container.
neuro job submit --env PYTHONPATH=/python --volume     storage:/data/2018q1:/data:ro --ssh 22 pytorch:latest

Options:

neuro job top

Display real-time job telemetry

Usage:

neuro job top [OPTIONS] ID

Options:

neuro login

Log into Neuromation Platform.

Usage:

neuro login [OPTIONS] [URL]

Options:

neuro logout

Log out.

Usage:

neuro logout [OPTIONS]

Options:

neuro model

Model operations.

Usage:

neuro model [OPTIONS] COMMAND [ARGS]...

Options:

Commands:

• neuro model debug: Starts ssh terminal connected to running job.

Job should be started with SSH support enabled.

• neuro model train: Start training job using model.

The training job is created from IMAGE, dataset from DATASET and store output weights in RESULTS.

COMMANDS list will be passed as commands to model container.

neuro model debug

Starts ssh terminal connected to running job.

Job should be started with SSH support enabled.

Usage:

neuro model debug [OPTIONS] ID

Examples:

neuro model debug --localport 12789 job-abc-def-ghk

Options:

neuro model train

Start training job using model.

The training job is created from IMAGE, dataset from DATASET and store
output weights in RESULTS.

COMMANDS list will be passed as commands to model container.

Usage:

neuro model train [OPTIONS] IMAGE DATASET RESULTS [CMD]...

Options:

neuro share

Shares resource specified by URI to a USER with PERMISSION

Usage:

neuro share [OPTIONS] URI USER [read|write|manage]

Examples:

neuro share storage:///sample_data/ alice manage neuro share
 image:resnet50 bob read neuro share job:///my_job_id alice write

Options:

neuro storage

Storage operations.

Usage:

neuro storage [OPTIONS] COMMAND [ARGS]...

Options:

Commands:

• neuro storage cp: Copy files and directories.

Either SOURCE or DESTINATION should have storage:// scheme. If scheme is omitted, file:// scheme is assumed.

• neuro storage ls: List directory contents.

By default PATH is equal user`s home dir (storage:)

• neuro storage mkdir: Make directories.
• neuro storage mv: Move or rename files and directories.

SOURCE must contain path to the file or directory existing on the storage, and DESTINATION must contain the full path to the target file or directory.

• neuro storage rm: Remove files or directories.

neuro storage cp

Copy files and directories.

Either SOURCE or DESTINATION should have storage:// scheme. If scheme is
omitted, file:// scheme is assumed.

Usage:

neuro storage cp [OPTIONS] SOURCE DESTINATION

Examples:

# copy local file ./foo into remote storage root
neuro storage cp ./foo storage:///
neuro storage cp ./foo storage:/

# download remote file foo into local file foo with
# explicit file:// scheme set
neuro storage cp storage:///foo file:///foo

Options:

neuro storage ls

List directory contents.

By default PATH is equal user`s home dir (storage:)

Usage:

neuro storage ls [OPTIONS] [PATH]

Options:

neuro storage mkdir

Make directories.

Usage:

neuro storage mkdir [OPTIONS] PATH

Options:

neuro storage mv

Move or rename files and directories.

SOURCE must contain path to the file or directory existing on the storage,
and DESTINATION must contain the full path to the target file or directory.

Usage:

neuro storage mv [OPTIONS] SOURCE DESTINATION

Examples:

# move or rename remote file
neuro storage mv storage://{username}/foo.txt storage://{username}/bar.txt
neuro storage mv storage://{username}/foo.txt storage://~/bar/baz/foo.txt

# move or rename remote directory
neuro storage mv storage://{username}/foo/ storage://{username}/bar/
neuro storage mv storage://{username}/foo/ storage://{username}/bar/baz/foo/

Options:

neuro storage rm

Remove files or directories.

Usage:

neuro storage rm [OPTIONS] PATH

Examples:

neuro storage rm storage:///foo/bar/
neuro storage rm storage:/foo/bar/
neuro storage rm storage://{username}/foo/bar/

Options:

neuro store

Alias for storage (DEPRECATED)

Usage:

neuro store [OPTIONS] COMMAND [ARGS]...

Options:

Commands:

• neuro store cp: Copy files and directories.

Either SOURCE or DESTINATION should have storage:// scheme. If scheme is omitted, file:// scheme is assumed.

• neuro store ls: List directory contents.

By default PATH is equal user`s home dir (storage:)

• neuro store mkdir: Make directories.
• neuro store mv: Move or rename files and directories.

SOURCE must contain path to the file or directory existing on the storage, and DESTINATION must contain the full path to the target file or directory.

• neuro store rm: Remove files or directories.

neuro store cp

Copy files and directories.

Either SOURCE or DESTINATION should have storage:// scheme. If scheme is
omitted, file:// scheme is assumed.

Usage:

neuro store cp [OPTIONS] SOURCE DESTINATION

Examples:

# copy local file ./foo into remote storage root
neuro storage cp ./foo storage:///
neuro storage cp ./foo storage:/

# download remote file foo into local file foo with
# explicit file:// scheme set
neuro storage cp storage:///foo file:///foo

Options:

neuro store ls

List directory contents.

By default PATH is equal user`s home dir (storage:)

Usage:

neuro store ls [OPTIONS] [PATH]

Options:

neuro store mkdir

Make directories.

Usage:

neuro store mkdir [OPTIONS] PATH

Options:

neuro store mv

Move or rename files and directories.

SOURCE must contain path to the file or directory existing on the storage,
and DESTINATION must contain the full path to the target file or directory.

Usage:

neuro store mv [OPTIONS] SOURCE DESTINATION

Examples:

# move or rename remote file
neuro storage mv storage://{username}/foo.txt storage://{username}/bar.txt
neuro storage mv storage://{username}/foo.txt storage://~/bar/baz/foo.txt

# move or rename remote directory
neuro storage mv storage://{username}/foo/ storage://{username}/bar/
neuro storage mv storage://{username}/foo/ storage://{username}/bar/baz/foo/

Options:

neuro store rm

Remove files or directories.

Usage:

neuro store rm [OPTIONS] PATH

Examples:

neuro storage rm storage:///foo/bar/
neuro storage rm storage:/foo/bar/
neuro storage rm storage://{username}/foo/bar/

Options:

Api

TODO

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