Install Evidently

Installing from PyPI

MAC OS and Linux

Evidently is available as a PyPI package.

To install it using the pip package manager, run:

$ pip install evidently

The tool allows building interactive reports inside a Jupyter notebook or as a separate HTML file, and generating JSON profiles.

If you only want to generate interactive reports as HTML files or JSON profiles, the installation is now complete.

To enable building interactive reports inside a Jupyter notebook, we use jupyter nbextension. If you want to create reports inside a Jupyter notebook, then after installing evidently you should run the two following commands in the terminal from the Evidently directory.

To install jupyter nbextention, run:

$ jupyter nbextension install --sys-prefix --symlink --overwrite --py evidently

To enable it, run:

$ jupyter nbextension enable evidently --py --sys-prefix

That's it!

Note: a single run after the installation is enough. No need to repeat the last two commands every time.

Note 2: if you use Jupyter Lab, you may experience difficulties with exploring reports inside a Jupyter notebook. However, the report generation in a separate HTML file will work correctly.

Windows

Evidently is available as a PyPI package.

To install it using the pip package manager, run:

$ pip install evidently

The tool allows building interactive reports inside a Jupyter notebook, as a separate HTML file, and generating JSON profiles.

Unfortunately, building reports inside a Jupyter notebook is not yet possible for Windows. The reason is Windows requires administrator privileges to create symlink. In later versions, we will address this issue.