Welcome to Deepchecks!#
Deepchecks is the leading tool for testing and for validating your machine learning models and data, and it enables doing so with minimal effort. Deepchecks accompanies you through various validation and testing needs such as verifying your data’s integrity, inspecting its distributions, validating data splits, evaluating your model and comparing between different models.
Join Our Community 👋
In addition to perusing the documentation, feel free to:
To support us, please give us a star ⭐️ on Github, it really means a lot for open source projects!
In order to use deepchecks, you need to install it with pip:
# deepchecks for tabular data: pip install deepchecks --upgrade # for installing deepchecks including the computer vision subpackage (note - Pytorch should be installed separately): pip install "deepchecks[vision]" --upgrade
For more installation details and best practices, check out our full installation instructions.
🏃♀️ See It in Action#
For a quick start, check out the following examples in the tutorials section, to have deepchecks up and running in a few minutes:
Head over to one of our following quickstart tutorials, and have deepchecks running on your environment in less than 5 min:
Recommended - download the code and run it locally on the built-in dataset and (optional) model, or replace them with your own.
🚀 See Our Checks Demo#
Play with some of the existing checks in our Interactive Checks Demo, and see how they work on various datasets with custom corruptions injected.
Note: CV Subpackage is in Beta Release
🙋🏼 When Should You Use Deepchecks?#
While you’re in the research phase, and want to validate your data, find potential methodological problems, and/or validate your model and evaluate it.
See the When Should You Use section for an elaborate explanation of the typical scenarios.
📊 Which Types of Checks Exist?#
They are checks for different phases in the ML workflow:
Train-Test Validation (Distribution, Drift and Methodology Checks)
Model Performance Evaluation
🧐 How Does it Work?#
Deepchecks is built of checks, each designated to help to identify a specific issue. Some checks relate only to the data and labels and some require also the model. Suites are composed of checks. Each check contains outputs to display in a notebook and/or conditions with a pass/fail/warning output. For more information about deepchecks structure and components head over to our Deepchecks Hierarchy in the User Guide.
❓ What Do You Need in Order to Start?#
Depending on your phase and what you wish to validate, you’ll need a subset of the following:
Raw data (before pre-processing such as OHE, string processing, etc.), with optional labels
The model’s training data with labels
Test data (which the model isn’t exposed to) with labels
- A supported model that you wish to validate, including: scikit-learn, XGBoost, PyTorch, and more.For tabular data models see supported models, for more details about the supported model API.For Computer Vision we support any framework, with special integrations for PyTorch andTensorFlow. See The Vision Data Class to understand how to integrate your data.
👀 Viewing and Saving the Results#
The package’s check and suite results can be consumed in various formats. Check out the following guides for more info about: