Skip to content

Installing the Neptune–Jupyter extension#

The Neptune–Jupyter (neptune-notebooks) Python package includes the following:

  • The standard Jupyter extension.1
  • The JupyterLab extension.1
  • A simple command-line interface (CLI) for uploading notebooks.

Installation#

Installing for Jupyter Notebook#

Before you begin, you should have Jupyter Notebook installed in your environment.

  1. Install the extension:

    pip install neptune-notebooks
    
    conda install -c conda-forge neptune-notebooks
    
  2. Enable the extension:

    jupyter nbextension enable --py neptune-notebooks
    

For Neptune installation instructions, see Installing Neptune.

Installing for JupyterLab#

Before you begin: The following must be installed on your system:

This installation of neptune-notebooks includes the neptune-client library as a dependency.

  1. On the command line, enter the following:

    pip install neptune-notebooks
    
  2. Start JupyterLab:

    jupyter lab
    
  3. In the "Build Recommended" notification, click Build.

    The build process can take up to several minutes.

  4. In the "Build Complete" notification, click Reload.

Note

This installation doesn't include the CLI for managing notebooks nor install neptune-client.

For Neptune installation instructions, see Installing Neptune.

  1. In JupyterLab, enable the Extension Manager through SettingsEnable Extension Manager.
  2. Find "neptune-notebooks" and click Install.

Verification#

To verify that the neptune-notebooks extension was successfully installed:

  1. Open a Jupyter notebook.
  2. In the top navigation, ensure that the Neptune Configure button has appeared.

Configuration#

After you have successfully installed the Jupyter extension for Neptune, connect it to your Neptune account.

  1. In your Jupyter notebook, click the Neptune Configure button.
  2. Enter your Neptune API token in the API token input box.

    How do I find my API token?

    In the top-right corner of the Neptune app, click your avatar 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!

  3. To register the notebook in Neptune, click Upload.

  4. To log metadata from the notebook automatically, in the top navigation menu, click Activate.

  1. The extension is written in JavaScript and visible in the web-based Jupyter UI.