Install the Neptune-Jupyter extension#
The Neptune-Jupyter (neptune-notebooks) Python package includes the following:
- The standard Jupyter extension.
- The JupyterLab extension.
- A simple command-line interface (CLI) for uploading notebooks.1
Installation#
Installing for Jupyter Notebook#
Before you begin, you should have Jupyter Notebook installed in your environment.
-
Install the extension:
-
Enable the extension:
For Neptune installation instructions, see Install Neptune.
Installing for JupyterLab#
JupyterLab note
The Neptune-Jupyter extension currently works for JupyterLab <4.0
.
Before you begin: The following must be installed on your system:
This installation of neptune-notebooks includes the neptune-client library as a dependency.
-
On the command line, enter the following:
-
Start JupyterLab:
-
In the "Build Recommended" notification, click Build.
The build process can take up to several minutes.
-
In the "Build Complete" notification, click Reload.
Note
This installation doesn't include the CLI for managing notebooks nor install neptune.
For Neptune installation instructions, see Install Neptune.
- In JupyterLab, enable the Extension Manager through Settings → Enable Extension Manager.
- Find "neptune-notebooks" and click Install.
Verification#
To verify that the neptune-notebooks extension was successfully installed:
- Open a Jupyter notebook.
- 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.
- In your Jupyter notebook, click the Neptune Configure button.
-
Enter your Neptune API token in the API token input box.
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!
-
To register the notebook in Neptune, click Upload.
- To log metadata from the notebook automatically, in the top navigation menu, click Activate.
-
This part of the integration has not yet been updated for neptune
1.x
. Use it with neptune-client0.16.18
. For instructions, see Setup ≫ Upgrade Neptune. ↩