Upload Jupyter notebook checkpoints#
Once you've installed the Neptune–Jupyter extension, you can snapshot your code by uploading notebook checkpoints.
Tip
- You can later download a checkpoint from Neptune with the Download button in Jupyter.
- You can also download checkpoints as
.ipynb
files directly from the Neptune app.
Manual upload#
To upload the current notebook as a checkpoint:
- In the Jupyter top navigation, click Upload.
- Select a project from the list.
- Optionally enter a checkpoint name and description. This makes it easier to identify and compare checkpoints in Neptune.
- Click Upload checkpoint.
Click the link in the confirmation message to open the notebook in Neptune.
Automatic upload when starting a run#
You can save notebook checkpoints automatically whenever you create a Neptune run in a notebook cell.
To connect your notebook and run, log the notebook to Neptune by clicking Upload in the Jupyter navigation.
After that, whenever you create a run in the notebook with neptune.init_run()
, the checkpoint will be logged automatically.
Troubleshooting#
Missing notebook checkpoints
When you restart the Jupyter kernel, your notebook checkpoints may not be saved to Neptune nor connected to the Neptune runs you created.
To fix that, re-activate your notebook by clicking Activate in the Jupyter navigation menu.
I changed my Neptune project, but the checkpoints are not appearing
If you want to move the notebook checkpoints to a new project, you need to first create a new notebook upload in the new project.
To go back to the previous project, download a checkpoint from there and continue logging from that point.