Upgrade the Neptune client library

You can upgrade your installation of the Neptune Python client library with the following command:

pip install -U neptune

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

Checking your current version

To determine your currently installed version of Neptune:

pip show neptune

Software requirements

Software	Version	Website
Python	3.8+	python.org/downloads
pip	-	pip.pypa.io

Upgrading from 0.x to 1.x

First uninstall the neptune-client library and then install neptune:

pip uninstall neptune-client

pip install neptune

To update your Python code for 1.x:

• In any Neptune import statements, change neptune.new to just neptune.
• If you're providing arguments positionally in your function calls, check if you should change them to include the argument names.
• If you're using deprecated functions or parameters, make sure to update those.
• Instead of log(), use append() (or extend(), if you're appending multiple values at once).
• If you're using Neptune in interactive Python sessions and want to monitor system metrics, set the related init parameters to True.
• If you've been relying on unsupported types being logged as strings, either:
  • Explicitly log those as strings
  • Use Neptune's stringify_unsupported() function
  • Look for a different way to log them with available Neptune methods.
• If you're querying and filtering runs based on state, change the following:
  • idle to inactive
  • running to active

For more, see the neptune 1.0 upgrade guide.

RuntimeError: Both packages installed

Error

We've detected that the 'neptune' and 'neptune-client' packages are both installed. Uninstall each of them and then install only the new 'neptune' package.

If you installed the neptune package on top of a previous installation of neptune-client, the Neptune client library will not work properly.

In this case, uninstall neptune-client and then reinstall neptune:

pip uninstall neptune-client

pip install --force-reinstall neptune

Downgrading to neptune-client<1.x with neptune installed

If you already installed the neptune package but want to revert to neptune-client, you need to first uninstall neptune and then reinstall the 0.16.18 version of the neptune-client package.

pip uninstall neptune

pip install --force-reinstall neptune-client==0.16.19