Skip to content

Install Neptune#

Prerequisites#

Software Version Website
Python 3.7+ python.org/downloads
pip or conda -

pip.pypa.io

docs.conda.io

Installation#

To install the Neptune client library, open a terminal and enter the following command:

pip install neptune
conda install -c conda-forge neptune
Installing through Anaconda Navigator

To find neptune, you may need to update your channels and index.

  1. In the Navigator, select Environments.
  2. In the package view, click Channels.
  3. Click Add..., enter conda-forge, and click Update channels.
  4. In the package view, click Update index... and wait until the update is complete. This can take several minutes.
  5. You should now be able to search for neptune.

Note: The displayed version may be outdated. The latest version of the package will be installed.

Note: On Bioconda, there is a "neptune" package available which is not the neptune.ai client library. Make sure to specify the "conda-forge" channel when installing neptune.ai.

Where to enter the command
  • Linux: Command line
  • macOS: Terminal app
  • Windows: PowerShell or Command Prompt
  • Jupyter Notebook: In a cell, prefixed with an exclamation mark: ! your-command-here
Upgrading with neptune-client already installed

Important: To smoothly upgrade to the 1.0 version of the Neptune client library, first uninstall the neptune-client library and then install neptune.

Step 1
pip uninstall neptune-client
Step 2
pip install neptune

Additional setup#

Need more help with getting started?

The Neptune tutorial walks you through the complete setup process and all the Neptune essentials.

Installing from GitHub#

You can install with pip from GitHub:

pip install git+https://github.com/neptune-ai/neptune-client.git

You can also clone the neptune-client repository and then install with:

pip install .