Installation#
Deepchecks requires Python 3 and can be installed using pip or conda, depending on the package manager that you’re working with for most of your packages.
As a best practice we recommend working on a virtual environment for pip and with a conda environment for conda.
Deepchecks For Tabular Data#
Local Installation With Pip#
The deepchecks package can be installed from PyPi using the following command:
pip install deepchecks --upgrade
Note
Deepchecks is in active development, which means that new versions are released on a weekly basis and new features are frequently added. If you experience any unexpected behavior from deepchecks, the first step to troubleshoot is to upgrade to the latest version.
Local Installation With Conda#
To install the deepchecks package from the conda package manager run
conda install -c conda-forge deepchecks
or, if you already have deepchecks installed and want to update then run
conda update -c conda-forge deepchecks
Installing Within a Jupyter Notebook#
Simply run the following command in a notebook cell
import sys
!{sys.executable} -m pip install deepchecks --quiet --upgrade # --user
Deepchecks For NLP#
Installation of deepchecks for NLP should be stated explicitly and it includes both the installation of the tabular version and of the nlp subpackage. Example commands from above should be altered to install deepchecks[nlp].
Using Pip#
pip install "deepchecks[nlp]" --upgrade
Installing Properties#
deepchecks for NLP uses text properties for some checks. In order for deepchecks to calculate the text properties of your data, there are additional dependencies that need to be installed. These can be installed using the following command:
pip install "deepchecks[nlp-properties]" --upgrade
Deepchecks For Computer Vision#
Installation of deepchecks for CV should be stated explicitly and it includes both the installation of the tabular version and of the computer vision subpackage. Example commands from above should be altered to install deepchecks[vision].
Using Pip#
pip install "deepchecks[vision]" --upgrade
Start Working with the Package#
Now it’s time to check out deepchecks!
Latest Version Check#
We are improving and updating our package constantly, so it’s important to work on the latest version whenever possible. Because of that, the package checks by default if it is the latest version. If not, a warning is printed.
As a side benefit, the latest version check helps us estimate how many people are using the package. We want to keep building and improving deepchecks, so this metric is important to us. The check is performed only once, on the first import of the package in the python context.
No credentials, data, personal information or anything private is collected, and will never be.
By default, the latest version check is turned on. You can opt-out at any time by setting the
DISABLE_LATEST_VERSION_CHECK environment variable to True.
export DISABLE_LATEST_VERSION_CHECK=True