Table of Contents

• Preface
• neuro
  • neuro job
    • neuro job submit
    • neuro job ls
    • neuro job status
    • neuro job exec
    • neuro job port-forward
    • neuro job logs
    • neuro job kill
    • neuro job top
  • neuro storage
    • neuro storage cp
    • neuro storage ls
    • neuro storage rm
    • neuro storage mkdir
    • neuro storage mv
  • neuro image
    • neuro image ls
    • neuro image push
    • neuro image pull
  • neuro config
    • neuro config login
    • neuro config show
    • neuro config show-token
    • neuro config auth
    • neuro config logout
  • neuro completion
    • neuro completion generate
    • neuro completion patch
  • neuro help
  • neuro submit
  • neuro ps
  • neuro status
  • neuro exec
  • neuro port-forward
  • neuro logs
  • neuro kill
  • neuro top
  • neuro login
  • neuro logout
  • neuro cp
  • neuro ls
  • neuro rm
  • neuro mkdir
  • neuro mv
  • neuro images
  • neuro push
  • neuro pull
  • neuro share
• 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

Usage:

neuro [OPTIONS] COMMAND [ARGS]...

Options:

Command Groups:

Commands:

neuro job

Job operations.

Usage:

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

Options:

Commands:

neuro job submit

Submit an image to run on the cluster.

IMAGE container image name.

CMD 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 ls

List all jobs.

Usage:

neuro job ls [OPTIONS]

Examples:

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

Options:

neuro job status

Display status of a job.

Usage:

neuro job status [OPTIONS] ID

Options:

neuro job exec

Execute command in a running job.

Usage:

neuro job exec [OPTIONS] ID CMD...

Options:

neuro job port-forward

Forward a port of a running job exposed with -ssh option to a local port.

Usage:

neuro job port-forward [OPTIONS] ID LOCAL_PORT REMOTE_PORT

Options:

neuro job logs

Print the logs for a container.

Usage:

neuro job logs [OPTIONS] ID

Options:

neuro job kill

Kill job(s).

Usage:

neuro job kill [OPTIONS] ID...

Options:

neuro job top

Display GPU/CPU/Memory usage.

Usage:

neuro job top [OPTIONS] ID

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.

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 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 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 image

Container image operations.

Usage:

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

Options:

Commands:

neuro image ls

List images.

Usage:

neuro image ls [OPTIONS]

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 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 config

Client configuration.

Usage:

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

Options:

Commands:

neuro config login

Log into Neuromation Platform.

Usage:

neuro config login [OPTIONS] [URL]

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 auth

Update authorization token.

Usage:

neuro config auth [OPTIONS] TOKEN

Options:

neuro config logout

Log out.

Usage:

neuro config logout [OPTIONS]

Options:

neuro completion

Output shell completion code.

Usage:

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

Options:

Commands:

neuro completion generate

Provide an instruction for shell completion generation.

Usage:

neuro completion generate [OPTIONS] [bash|zsh]

Options:

neuro completion patch

Automatically patch shell configuration profile to enable completion

Usage:

neuro completion patch [OPTIONS] [bash|zsh]

Options:

neuro help

Get help on a command.

Usage:

neuro help [OPTIONS] [COMMAND]...

Options:

neuro submit

Submit an image to run on the cluster.

IMAGE container image name.

CMD list will be passed as commands to model container.

Usage:

neuro 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 ps

List all jobs.

Usage:

neuro ps [OPTIONS]

Examples:

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

Options:

neuro status

Display status of a job.

Usage:

neuro status [OPTIONS] ID

Options:

neuro exec

Execute command in a running job.

Usage:

neuro exec [OPTIONS] ID CMD...

Options:

neuro port-forward

Forward a port of a running job exposed with -ssh option to a local port.

Usage:

neuro port-forward [OPTIONS] ID LOCAL_PORT REMOTE_PORT

Options:

neuro logs

Print the logs for a container.

Usage:

neuro logs [OPTIONS] ID

Options:

neuro kill

Kill job(s).

Usage:

neuro kill [OPTIONS] ID...

Options:

neuro top

Display GPU/CPU/Memory usage.

Usage:

neuro 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 cp

Copy files and directories.

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

Usage:

neuro 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 ls

List directory contents.

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

Usage:

neuro ls [OPTIONS] [PATH]

Options:

neuro rm

Remove files or directories.

Usage:

neuro 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 mkdir

Make directories.

Usage:

neuro mkdir [OPTIONS] PATH

Options:

neuro 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 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 images

List images.

Usage:

neuro images [OPTIONS]

Options:

neuro 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 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 pull

Pull an image from platform registry.

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

Usage:

neuro 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 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:

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