.. image:: /_static/images/general/deepchecks-logo-with-white-wide-back.png
   :target: https://deepchecks.com/?utm_source=docs.deepchecks.com&utm_medium=referral&utm_campaign=welcome
   :alt: Deepchecks Logo
   :align: center

========================
Welcome to Deepchecks!
========================

Deepchecks is the leading tool for testing, validating and 
:doc:`monitoring <deepchecks-mon:getting-started/welcome>` 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.

.. image:: /_static/images/general/checks-and-conditions.png
   :alt: Deepchecks Suite of Checks
   :width: 75%
   :align: center

|

.. _welcome__start_working:

Start Working with Deepchecks Testing
==========================================

.. grid:: 1
    :gutter: 3

    .. grid-item-card:: 🏃‍♀️ Tabular Quickstarts 🏃‍♀️
        :link-type: doc
        :link: /user-guide/tabular/auto_quickstarts/index
        
        End-to-end guides to start testing your tabular data & model in 5 minutes.

    .. grid-item-card:: 💁‍♂️ Get Help & Give Us Feedback 💁
        :link-type: ref
        :link: welcome__get_help
   
        Links for how to interact with us via our `Slack Community  <https://www.deepchecks.com/slack>`__ 
        or by opening `an issue on Github <https://github.com/deepchecks/deepchecks/issues>`__.

   
    .. grid-item-card:: 🤓 User Guide 🤓
        :link-type: doc
        :link: /user-guide/index
         
        A comprehensive view of deepchecks concepts,
        customizations, and core use cases.
   
    .. grid-item-card:: 💻  Install 💻 
        :link-type: doc
        :link: /getting-started/installation

        Full installation guide (quick one can be found in quickstarts)

    .. grid-item-card:: 🚀 Interactive Demo of the Tabular Checks 🚀
        :link-type: url
        :link: https://checks-demo.deepchecks.com/?check=No+check+selected
             &utm_source=docs.deepchecks.com&utm_medium=referral&
             utm_campaign=welcome_page&utm_content=checks_demo_card
      
        Play with some of the existing tabular checks
        and see how they work on various datasets with custom corruptions injected.
      
    .. grid-item-card:: 🤖 API Reference 🤖
        :link-type: doc
        :link: /api/index
            
        Reference and links to source code for Deepchecks' components

    .. grid-item-card:: 🏃‍♀️ Vision Quickstarts (Note: CV is in Beta Release) 🏃‍♀️
        :link-type: doc
        :link: /user-guide/vision/auto_quickstarts/index
         
        End-to-end guides demonstrating how to start working with various CV use cases 
        (object detection, classification and more)

    .. grid-item-card:: 🔤️ NLP Quickstarts (Note: NLP is in Alpha Release) 🔤️
        :link-type: doc
        :link: /user-guide/nlp/auto_quickstarts/index

        Initial release demonstrating how to test NLP models and data. Future releases
        to come! Currently supports text classification and token classification.


.. _welcome__get_help:

Get Help & Give Us Feedback
============================

.. admonition:: Join Our Community 👋
   :class: tip

   In addition to perusing the documentation, feel free to:

   - Ask questions on our `Slack Community <https://www.deepchecks.com/slack>`__,
   - Post an issue or start a discussion on `Github Issues <https://github.com/deepchecks/deepchecks/issues>`__.

   To support us, please give us a star ⭐️ on `Github <https://github.com/deepchecks/deepchecks>`__, it really means a lot for open source projects!

Deepchecks' Components
=======================

Continuous validation of ML models and data includes testing throughout the model's lifecycle:

.. image:: /_static/images/welcome/testing_phases_in_pipeline.png
   :alt: Phases for Continuous Validation of ML Models and Data
   :align: center

|

Head over to the relevant documentation for more info:

.. grid:: 1
    :gutter: 3

    .. grid-item-card:: Testing Package (Here)
        :link-type: ref
        :link: welcome__start_working
        :img-top: /_static/images/welcome/research_title.png
        :columns: 4

        Tests during research and model development
    
    .. grid-item-card:: Testing Package CI/CD Usage
        :link-type: doc
        :link: /user-guide/general/ci_cd
        :img-top: /_static/images/welcome/ci_cd_title.png
        :columns: 4
        
        Tests before deploying the model to production

    .. grid-item-card:: Monitoring
        :link-type: ref
        :link: deepchecks-mon:welcome__start_with_deepchecks_monitoring
        :img-top: /_static/images/welcome/monitoring_title.png
        :columns: 4

        Tests and continuous monitoring during production