Jovian: The platform for all your Data Science projects

jovian is an open-source Python package integrated with Jovian to provide the tools necessary for Data Scientists and ML/DL Engineers to Track, Collaborate and Automate projects where even Students and Enthusiasts can leverage the same and also use Jovian Share and Showcase their projects.

• Upload and share Jupyter Notebooks
• Reproduce Notebooks from Jovian
• Notebooks as version, view Diffs between versions
• Attaching utility files and model outputs with the Notebook
• Tracking Datasets, Hyperparameters and Metrics
• Comparing and Analyzing all the experiments
• Collaborate with teammates/colleagues
• Stay connected with your model training, live updates with Slack Notifications

Installation

pip install jovian --upgrade

Caution:

If you get a Permission denied error, try installing with sudo permission (on Linux/Mac).

sudo pip install jovian --upgrade

Another alternative is to try installing with the --user flag, but you’ll need to ensure that the target directory is added to your system PATH.

pip install jovian --upgrade --user

Visit Docs for more.

Contact

Mail : [email protected] Twitter : @JovianML Slack : Slack Invite

Requirements

• JupyterLab >= 0.30.0
• Jovian >= 0.1.89
• nodejs >= 10.20.0

Jupyter Lab Extension

Now you can commit your Jupyter Notebook to Jovian with just One Click. Make sure you’ve completed the Installation before reading further.

Using Jovian Jupyter Lab Extension

Once you have successfully installed jovian, a new button Commit will appear on the tool bar. When using Commit button for first time you'll be asked to provide an API key.

You can get the API key at Jovian. Once you log in, just click on API key button, and the key will be copied to the clipboard.

Valid API key

If the key is valid you will be notified with the following alert.

Error with API key

If the entered API key is invalid you will get following error.

Successful Commit

Once the API key has been validated, you can start committing to Jovian by clicking Commit button. Once the Notebook has been committed successfully you will get the confirmation message with the link where the Jupyter Notebook has been uploaded to, you can click the link to your Notebook in Jovian.

Commit with more options

This makes use of jovian.commit's parameters to enable the user to commit with preferences like private notebook, new notebook project, to add outputs and files .....

Step 1: click the dropdown menu

Step 2: choose commit with options

Note: By default the parameters are derived from jovian.commit, changes to any parameter persists after commit.

Step 3: Click on Commit to commit the notebook with following options.

Install Jovian Juputer Lab Extension

You can use NPM to install the extension by running the following command.

$ Coming soon

Enable or Disable the extension

You can also disable the extension by running the following command.

$ jupyter labextension disable Jovian

To Enable the Notebook Extension, when you have manually disabled it.

$ jupyter labextension enable Jovian

Contributing

Install

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Move to sampleButtonExt directory
# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension link .
# Rebuild Typescript source after making changes
jlpm build
# Rebuild JupyterLab after making any changes
jupyter lab build

You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.

# Watch the source directory in another terminal tab
jlpm watch
# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch

Uninstall

jupyter labextension uninstall sampleButtonExt