Skip to content

Upload Jupyter notebook checkpoints through CLI#

Neptune compatibility note

This part of the integration has not yet been updated for neptune 1.x. Use it with neptune-client 0.16.18.

For instructions, see Setup ≫ Upgrade Neptune.

Info

We recommend uploading with CLI only if using the Jupyter extension is not possible.

You can upload notebooks and update notebook checkpoints with the Neptune command-line interface (CLI).

Before you start#

  1. Install the neptune-notebooks Python package, as described in Install the extension.

  2. Export your Neptune API token as an environment variable:

    export NEPTUNE_API_TOKEN="uyVrZXkiOiIzNTd..."

    export NEPTUNE_API_TOKEN="uyVrZXkiOiIzNTd..."

    set NEPTUNE_API_TOKEN="uyVrZXkiOiIzNTd..."
    How do I find my API token?

    In the bottom-left corner of the Neptune app, expand the user menu and select Get your API token.

    You can copy your token from the dialog that opens. It's very long – make sure to copy and paste it in full!

CLI usage#

Command syntax: neptune notebook sync [ARGS...]

Options           Description
--new (Optional) Creates a new notebook in Neptune.

If the notebook is not known to Neptune, it will be created. In this case, you do not need to use this flag.
--project <project-name> Project name (workspace-name/project-name) to which notebooks or checkpoints should be added.

If the NEPTUNE_PROJECT environment variable is set, this command overrides the environment variable.
--update (Optional) Updates the notebook in Neptune by adding a new checkpoint to it.

If the notebook is known to Neptune, it will be updated. In this case, you do not need to use this flag.

Example#

neptune notebook sync --project ml-team/ner model_tuning.ipynb

Uploading the same notebook file as a new notebook in Neptune:

neptune notebook sync --project ml-team/ner model_tuning.ipynb --update

Related