Home

Welcome to the neptune.ai docs!

Neptune is a metadata store that offers experiment tracking and model registry for machine learning researchers and engineers. With Neptune, you can log, query, manage, display, and compare all your model metadata in a single place.

•  Try it out

  ---

  See how it works with our 5-minute "Hello Neptune" example.

  No registration required.

  Quickstart

•  Overview

  ---

  What is Neptune? What can you do with it? The introduction should answer most of your questions.

  About Neptune

•  Set it up

  ---

  Head straight to installation and setup.

  Installing Neptune

  Interested in Neptune on-premises?

  Deploying Neptune on your server

•  Take the tutorial

  ---

  Start from the beginning, set up a sample project, and learn the central Neptune functions.

   Neptune tutorial

   Neptune R tutorial

• What's new in the docs

  Date	Changes
  Mar 20, 2023	New page: Logging Git info. We also clarified that you can set your own index when logging metrics or other series of values.
  Mar 15, 2023	With the 2.3 release of on-prem Neptune, we're adding an On-prem tab to the docs site. You can find installation instructions, FAQs, and other information there.
  Feb 23, 2023	The docs have been adjusted for the newly released version 1.0 of the Neptune client library. The neptune 1.0 upgrade guide describes all the changes, and we added a page on how to deal with unsupported types in case you run into that issue following the upgrade.
  Feb 14, 2023	Published a new storage troubleshooting guide. Significantly updated the Kedro integration guide.
  Feb 3, 2023	Added two explainer pages: using handlers for logging and using the wait() and sync() operations to synchronize metadata across processes. Also clarified how to log from different ranks in multi-node jobs.
  Jan 30, 2023	Released API references that were missing for integration libraries. Published guide on using the model registry with Amazon SageMaker. Added a new page for logging charts and plots and improved discoverability of related topics.
  Jan 23, 2023	Added introductory guide to the Neptune-AWS integration. Added examples for logging after fitting or testing to the Lightning and fastai guides.

  Looking for product release notes? See the Changelog

• Navigating the docs

  Tab	Contents
  Home	Introduction, changelogs, installation, and setup. You'll also find information about on-premises deployment and the legacy API here.
  Using Neptune	Once you're all set up, in this section you'll find explanations and tips for getting the most out of Neptune. Look here for what kinds of metadata you can log and display.
  Integrations	Detailed guides on using Neptune together with supported libraries, tools, and environments. Neptune integrates directly with several popular ML frameworks.
  Tutorials	Practical walkthroughs and MLOps use cases.
  API	API reference material and everything you need to know about our client library. Includes Neptune CLI usage instructions.
  On-prem	Information about the on-premises version of Neptune, including installation instructions and FAQ.
  Help	If you're facing problems or have questions, we're here to help.

---

Change cookie settings →