.. _nlp__index:

===
NLP
===

Deepchecks NLP sub package contain a large variety of checks and suites for different use cases.
Jump over to the :ref:`nlp__quickstarts` in the Tutorials section to get started,
or visit the :ref:`getting-started__installation` for a full 
guide about how to set up your environment.

Help us develop it further! You can provide feedback and suggestions as issues on
`GitHub <https://github.com/deepchecks/deepchecks/issues>`__, or by joining our
`Community Slack <https://www.deepchecks.com/slack>`__.

.. image:: /_static/images/general/nlp-checks.gif
   :alt: Deepchecks NLP Check Results
   :width: 50%
   :align: center

.. _nlp__index_tutorials:

Tutorials
---------

This section contain tutorials for different use cases, and how to use deepchecks in your workflow.

.. toctree::
    :maxdepth: 1
    :caption: Tutorials

    auto_tutorials/quickstarts/index

Usage Guides
------------

This section contain in-depth guides on different aspects and components of the deepchecks nlp sub package.

.. toctree::
    :titlesonly:
    :maxdepth: 0
    :caption: Usage Guides

    usage_guides/text_data_object
    usage_guides/supported_tasks
    usage_guides/nlp_properties
    usage_guides/nlp_metadata
    usage_guides/nlp_embeddings

.. _nlp__checks_gallery:

Checks Gallery
--------------

Below in the full list of checks and suites available in the deepchecks nlp sub package.

.. toctree::
    :hidden:
    :titlesonly:
    :maxdepth: 2
    :caption: Checks Gallery

    auto_checks/data_integrity/index
    auto_checks/train_test_validation/index
    auto_checks/model_evaluation/index