Getting Started

Installing Neuro and Logging In #

pip install -U neuromation neuro login

Paste that in a macOS, Windows, or Linux terminal prompt. This command automatically installs Neuro CLI and brings you to the log you in screen of Neuro Platform.

Neuro Platform CLI requires Python 3.7 installed. We suggest installing Anaconda Python 3.7 Distribution. On some distributions, you might have to run pip3 install -U neuromation.

Running Your First Job #

From your terminal or command prompt, with CLI installed and logged in, run:

neuro run \ --name jupyter \ --preset gpu-small \ --http 8888 \ --detach \ --browse \ --volume ALL \ neuromation/base \ 'jupyter notebook --no-browser --ip=0.0.0.0 --allow-root --NotebookApp.token= --notebook-dir=/var/neuro'

Let's look closely at each line:

  • neuro run starts a job on Neuro Platform;
  • --name jupyter: unique IDs identify jobs, but you can also give a job a meaningful name, which you can use in all job-related commands;
  • --preset gpu-small: you can execute jobs with different amount of GPU/CPU/RAM resources allocated; you can run neuro config show to see the available configurations;
  • --http 8888: this job exposes this HTTP port, so that you can access Jupyter notebook web IU;
  • --detach: by default, you are attached to a job, getting its logs in your terminal; to attach to an already running job you may use neuro logs jupyter;
  • --browse: this option enables Neuro CLI to open the web interface provided by the job in your default browser; you can always reopen it with neuro job browse jupyter;
  • --volume ALL: your storage is a persistent entity, and to use the data from your storage you have to attach the required folders to a job explicitly. ALL is a handy shortcut which attaches all the data from your storage, as well as all the content other users have shared with you;
  • neuromation\base is an environment in which this job runs; this one is our default environment which contains Tensorflow, Keras, PyTorch, TensorBoard, Jupyter, and JupyterLab;
  • 'jupyter notebook --no-browser --ip=0.0.0.0 --allow-root --NotebookApp.token= --notebook-dir=/var/neuro' is an actual command executed by this job.

While you read all the text above, the Neuro CLI has most probably already opened Jupyter notebook in your browser. Do not forget to finish the job when you are done, by running neuro kill jupyter or clicking a "KILL" button on your dashboard.