Skip to content

Getting started#

The following is a quick procedure for getting set up in a typical environment. Fore more installation details, see Install Neptune.

  1. Sign up at .

  2. Create a project.

  3. Install the Neptune client library:

    pip install -U neptune
  4. Set your Neptune API token to the NEPTUNE_API_TOKEN environment variable.

    How to find your Neptune API token

    export NEPTUNE_API_TOKEN="uyVrZXkiOiIzNTd0Zj..ifQ=="
  5. Set the name of your Neptune project to the NEPTUNE_PROJECT environment variable.

    You can copy the full name in your project's Edit project details menu.

    How to access project details

    export NEPTUNE_PROJECT="workspace-name/project-name"

For more detailed instructions, see the pages in the left menu.

All set

You can now import Neptune in your code and start logging.

import neptune

run = neptune.init_run() # (1)!

run["my/namespace/structure"] = some_metadata
  1. We don't recommend it, but you can also pass your info when initializing Neptune:

    import neptune
    run = neptune.init_run(

Neptune also integrates directly with the most popular ML frameworks. Instead of manual logging, you can use the integrations to log typical metadata. For more, see Integrations

Next steps: