API Reference

Neptune client library has the following main components:

Class

Description

Neptune

A global object that that you can use to start new tracked runs or re-connect to already existing ones. It also provides some convenience functionalities like fetching last created run. Similar to Numpy’s import numpy as np statement. In Neptune, you write import neptune.new as neptune.

Run

This is an object to which you log any piece of information you consider to be important during your run. Interaction with the run feels similar to interacting with a 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 runs in one script. You can re-instantiate the runs you have created in the past and update them.

Integrations

A sub module containing boiler plate for integrations with other frameworks. Check all the integrations Neptune supports here.

Project

An object representing a project in your workspace that can be used to interact with the project as a whole like fetching data from the Runs table.

Command Line Interface

The Neptune CLI (Command-Line Interface) allows you to check the status of local offline storage and upload the tracked metadata if you are using Offline mode or in case of a connection failure.

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