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
  Dec 1, 2022	Added instructions for downloading and exporting data from the web app. Published tutorial for how to fetch the metadata of a failed run in order to re-run a training with the same config. Clarified limitations of namespaces and fields.
  Nov 25, 2022	Improved instructions for tracking artifacts from Google Cloud Storage.
  Nov 24, 2022	Added instructions for the neptune clear CLI command. Made some corrections to the fastai integration guide, and the Keras integration guide and API reference.
  Nov 17, 2022	Clarified best practices for setting a custom run ID. Improved accuracy of the Prophet integration guide.
  Nov 1, 2022	New tutorial: Tracking and visualizing cross-validation results in Neptune
  Oct 27, 2022	Recently added pages are now highlighted in the navigation. Added overview page for using and customizing the runs table. Added instructions for tracking artifacts from S3-compatible storage other than Amazon S3. Improved text logging instructions.
  Oct 18, 2022	New pages: Essential logging methods and Editing object details. Improved instructions on querying metadata from artifact fields. Upgraded the search functionality.
  Oct 11, 2022	Corrected the description of the report_to argument in the Transformers guide. Documented the revamped image series gallery.

  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.
  Help	If you're facing problems or have questions, we're here to help.