How to version Jupyter notebooks¶

Introduction¶

This guide will show you how to:

Install neptune-notebook extension for Jupyter Notebook or JupyterLab
Connect Neptune to your Jupyter environment
Log your first notebook checkpoint to Neptune and see it in the UI

By the end of it, you will see your first notebook checkpoint in Neptune!

Before you start¶

Make sure you meet the following prerequisites before starting:

Have Python 3.x installed
Have Jupyter Notebook or JupyterLab installed
Have node.js installed if you are using JupyterLab
Note

If you are using conda you can install node with:
conda install -c conda-forge nodejs

Step 1 - Install neptune-notebooks¶

Jupyter Notebook

To install neptune-notebooks on Jupyter Notebook:

Install neptune-notebooks extension:

pip install neptune-notebooks

Enable the extension for Jupyter Notebook:

jupyter nbextension enable --py neptune-notebooks

JupyterLab

To install neptune-notebooks on JupyterLab go to your terminal and run:

jupyter labextension install neptune-notebooks

Note

Remember that you need to have node.js installed to use JupyterLab extensions.

Step 2 - Create some Notebook¶

Create a notebook with some analysis in it.

For example, you can use this code to create an interactive Altair chart of the cars dataset:

Add installation command in the first cell
pip install altair vega_datasets

Create Altair chart in the second cell

import altair as alt
from vega_datasets import data

source = data.cars()

brush = alt.selection(type='interval')

points = alt.Chart(source).mark_point().encode(
    x='Horsepower:Q',
    y='Miles_per_Gallon:Q',
    color=alt.condition(brush, 'Origin:N', alt.value('lightgray'))
).add_selection(
    brush
)

bars = alt.Chart(source).mark_bar().encode(
    y='Origin:N',
    color='Origin:N',
    x='count(Origin):Q'
).transform_filter(
    brush
)

chart = points & bars

chart