Skip to content

Using Neptune#

Getting started#

 In a hurry? Try the quickstart

 Missed the setup part? Go back to installation and setup

 Looking for a fully guided setup and orientation experience? Take the Neptune tutorial


Assumptions

For the topics in this section, we generally assume that you have:

  1. Registered with Neptune. neptune.ai/register
  2. Installed the Neptune client library: pip install neptune-client (or see Installing Neptune)
  3. Saved your API token and project name as environment variables.

    If you have not done this, you can pass your info when initializing Neptune, if needed:

    run = neptune.init_run(
        project="your-workspace-name/your-project-name",  # (1)!
        api_token="YourNeptuneApiToken",  # (2)!
    )
    
    1. The full project name. For example, "ml-team/classification". To copy it, navigate to the project settingsProperties.
    2. To copy your token, click your avatar in the Neptune app and select Get your API token. When you're done testing, save your API token as an environment variable instead of putting it here in the code!

For more, see Best practices.

Docs by category#

Examples on GitHub#

In the neptune-ai/examples repo on GitHub, you can browse our full library of example scripts, notebooks, and Neptune projects.

Visit examples repo 

Notebooks in Colab#

All of our Jupyter Notebook examples are listed below.

Not what you're looking for?

Want to follow more comprehensive, practical examples? Tutorials

Wondering how to use Neptune with a specific library or tool? Integrations