Neptune Python Library Reference

Main Library Classes

The following are the main classes in the Neptune Python Library:

Class

Description

Neptune

A global object that provides the convenience of doing most of the logging using a single neptune global variable, similar to Numpy’s import numpy as np statement - in Neptune, write import neptune.

Session

When you are creating a Neptune session, you identify yourself with an API token so that the client knows which projects you have access to.

Project

This is the Neptune project to which you want to log things. You need to create it in the application. This is a place where you can create experiments. You can create new ones and update or download information from the existing one.

Experiment

This is an object to which you log any piece of information you consider to be important during your run. Interaction with the experiment feels similar to interacting with a Singleton dictionary object. Neptune gives you all the freedom: You simply log metrics, images, text and everything else to particular names and those objects are sent to the application. You can have one or multiple experiments in one script. You can reinstantiate the experiments you have created in the past and update them.

Notebook

Contains all the information about a Neptune Jupyter Notebook.

Utils

Keeps information about the Git repository in an experiment.

Downloading Project and Experiment Data from Neptune

A subset of the Neptune Python Library provides methods for downloading project and experiment data from Neptune.

For more information, see Fetching Data From Neptune.