API Reference

The Neptune ecosystem consists of the following major libraries:

neptune-client

The main Python client. It has the following main classes:

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, you write import neptune.

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 re-instantiate the experiments you have created in the past and update them.

Learn how to get started with logging and managing experiment data using Neptune here.

neptune-contrib

The library with community extensions. This is what you use to integrate Neptune with other frameworks. Check all the integrations Neptune supports here.

neptune-tensorboard

Supports packages and functions for Neptune’s integration with TensorBoard. Read how to integrate Neptune with TensorBoard here.