:orphan:

.. _tabular__quickstarts:

Quickstarts
===========

Deepchecks has built-in Suites to enable you to run many Checks at various points throughout the research phase.
The following quickstarts exemplify how to run each of these suites with only a few lines of code.

.. image:: /_static/images/general/pipeline_when_to_validate.svg
   :alt: When To Validate - ML Pipeline Schema
   :align: center


These are great as initial entry points to get familiar with the value you can get from deepchecks.
For more info about each of the recommended scenarios, check out the :ref:`when_should_you_use_deepchecks` guide.
For the API reference of each of the built-in Suites, check out :mod:`deepchecks.tabular.suites`.

Of course, every research process has its unique steps and challenges, and therefore all checks and suites can easily customized,
more info about customizations of suites, conditions, checks, etc. can be found in the :ref:`tabular__index`.

Quickstarts:
------------


.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In order to run your first Deepchecks Suite all you need to have is the data and model that you...">

.. only:: html

  .. image:: /tabular/auto_tutorials/quickstarts/images/thumb/sphx_glr_plot_quickstart_in_5_minutes_thumb.png
    :alt:

  :ref:`sphx_glr_tabular_auto_tutorials_quickstarts_plot_quickstart_in_5_minutes.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Full Suite Quickstart</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The deepchecks model evaluation suite is relevant any time you wish to evaluate your model. For...">

.. only:: html

  .. image:: /tabular/auto_tutorials/quickstarts/images/thumb/sphx_glr_plot_quick_model_evaluation_thumb.png
    :alt:

  :ref:`sphx_glr_tabular_auto_tutorials_quickstarts_plot_quick_model_evaluation.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Model Evaluation Suite Quickstart</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The deepchecks integrity suite is relevant any time you have data that you wish to validate: wh...">

.. only:: html

  .. image:: /tabular/auto_tutorials/quickstarts/images/thumb/sphx_glr_plot_quick_data_integrity_thumb.png
    :alt:

  :ref:`sphx_glr_tabular_auto_tutorials_quickstarts_plot_quick_data_integrity.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Data Integrity Suite Quickstart</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The deepchecks train-test validation suite is relevant any time you wish to  validate two data ...">

.. only:: html

  .. image:: /tabular/auto_tutorials/quickstarts/images/thumb/sphx_glr_plot_quick_train_test_validation_thumb.png
    :alt:

  :ref:`sphx_glr_tabular_auto_tutorials_quickstarts_plot_quick_train_test_validation.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Train-Test Validation Suite Quickstart</div>
    </div>


.. raw:: html

    </div>


.. toctree::
   :hidden:

   /tabular/auto_tutorials/quickstarts/plot_quickstart_in_5_minutes
   /tabular/auto_tutorials/quickstarts/plot_quick_model_evaluation
   /tabular/auto_tutorials/quickstarts/plot_quick_data_integrity
   /tabular/auto_tutorials/quickstarts/plot_quick_train_test_validation


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download all examples in Python source code: quickstarts_python.zip </tabular/auto_tutorials/quickstarts/quickstarts_python.zip>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download all examples in Jupyter notebooks: quickstarts_jupyter.zip </tabular/auto_tutorials/quickstarts/quickstarts_jupyter.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_