Notebooks in Neptune

Introduction

Notebooks are essential tool for data scientists, regardless their area of specialization. They allow data scientists to work interactively, keeping code and results - like visualizations - in a single document. Neptune builds on top of this experience and comes with Jupyter and JupyterLab extensions that let you track Notebooks in Neptune.

Notebooks in Neptune - key features:

  • In Neptune, each notebook consist of collection of checkpoints that you upload directly from the Jupyter User interface.

  • In the project, unlimited number of notebooks and checkpoints is allowed.

  • Browse checkpoints history across all notebooks in the project,

  • Share notebook as a link,

  • Compare two notebooks side-by-side like source code.

Quick-start

  • To start working with notebooks in Neptune, install and configure open source extension for Jupyter or JupyterLab. When you have it done, you can start working with notebooks immediately.

  • To try it now, without registering to Neptune, look at example notebooks in public project onboarding. Use public user’s API token (username: neptuner) to upload some snapshots to this project (you still need to install and configure Jupyter extension).

eyJhcGlfYWRkcmVzcyI6Imh0dHBzOi8vdWkubmVwdHVuZS5tbCIsImFwaV9rZXkiOiJiNzA2YmM4Zi03NmY5LTRjMmUtOTM5ZC00YmEwMzZmOTMyZTQifQ==

Tour

Notebooks view is a collection of all notebooks in the project - each can have multiple checkpoints.

Notebooks view

  • See what your team members are working on now.

  • Review details and checkpoints associated with Notebook.

  • Share, compare or download notebook.

image

Notebook contents

Once you entered notebook, you can see all its content, that is: code and markdown cells, outputs and execution count.

  • Look at the snapshot of the work with notebook.

  • Download, share or compare this checkpoint.

image

Notebooks comparison

Select two notebooks and compare their contents - code and markdown cells, outputs and execution count - side-by-side just like source code. Compare view let you look at diff between checkpoints of the same notebook, or two entirely different notebooks (Try yourself here).

image
  • Code, markdown, output and execution count differences highlighted.

  • Top bar displays summary information about diff.

Upload notebook checkpoint

Once configured, you can see two Neptune buttons.

    • n button is for configuration changes

    • Upload button is for making checkpoint in Neptune (see below)

image
    • Click Upload, whenever you want to create new checkpoint in Neptune.

    • You will see tooltip with link as a confirmation.

image