experiment send-notebook

Start a new Jupyter notebook in the cloud.

Usage

neptune experiment send-notebook [-f [NOTEBOOK-FILE]] [-w WORKER] [-i INPUT] [-e ENVIRONMENT]
  [-x EXCLUDE] [-b FILE-OR-DIR]
  [--pip-requirements-file PIP-REQUIREMENTS-FILE]
  [--name NAME] [--description DESCRIPTION] [--tag TAG]
  [--property PROPERTY] [--project PROJECT]
  [--open-webbrowser [true|false]] [--config CONFIG-FILE] [-h]
  [-v] [--profile PROFILE] [--debug]

Essential Options

Parameter Description
-f, --notebook-file Location of the notebook file (relative to storage root).
If this option is omitted, an empty notebook will be created.
-w, --worker A virtual machine type to run your experiment on. Visit
https://docs.neptune.ml/advanced-topics/environments/#available-workers
for a list of Neptune’s worker types.
You can use --worker local to run your experiment locally.
-i, --input A file or directory in Neptune’s storage that should be made accessible to the
experiment in the /input directory. You can use this option multiple times to
pass multiple inputs.
This option is available only for experiments executed in the cloud, i.e. it’s
incompatible with --worker local.
Syntax:
   -i path_on_storage[:name_visible_to_experiment]
   --input path_on_storage[:name_visible_to_experiment]
Example:
   --input my_input.txt:renamed_input.txt
The experiment’s code can access the file at /input/renamed_input.txt
   --input my_input.txt
The experiment’s code can access the file at /input/my_input.txt
-e, --environment A machine learning environment. Visit
https://docs.neptune.ml/advanced-topics/environments/
for a list of environments supported by Neptune.

Advanced Options

Parameter Description
-x, --exclude Files and directories that Neptune should leave out when uploading snapshot of
your code to the storage.
Wildcards are supported.
Example:
    --exclude .git --exclude service/*.log
-b, --backup Files and directories that should be uploaded to Neptune’s storage after the
experiment ends.
--pip-requirements-file A file containing a list of Python packages that your experiment needs.
Requirements file format with an example file can be found here:
http://pip.pypa.io/en/stable/reference/pip_install/#requirements-file-format

Experiment Characteristics

Parameter Description
--name Experiment’s name.
--description Experiment’s description.
Giving a detailed description is often extremely useful when coming back to the
experiment after some time.
--tag Experiment’s tags.
Use tags to quickly filter experiments.
--property Key-value pairs containing information you wish to associate with the
experiment.
Syntax:
    --properties key:value [key:value ...]
Example:
    --properties model-type:svm dataset:my-data-v3

Configuration

Parameter Description
--project Your project’s name.
You can set this globally using the neptune project activate command.
--open-webbrowser Automatically open browser when a new experiment is started.

Global Options

Parameter Description
--config Path to a Neptune CLI configuration file.
-h, --help Show this help message and exit.
-v, --version Show Neptune CLI version and exit.
--profile Set user profile to use.
--debug Run command with additional debug-level logging.