diff --git a/docs/source/_static/images/general/deepchecks-testing-logo.svg b/docs/source/_static/images/general/deepchecks-testing-logo.svg new file mode 100644 index 0000000000..28d01a0b51 --- /dev/null +++ b/docs/source/_static/images/general/deepchecks-testing-logo.svg @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + diff --git a/docs/source/_static/images/general/model-evaluation-suite.gif b/docs/source/_static/images/general/model-evaluation-suite.gif new file mode 100644 index 0000000000..b11de456d2 Binary files /dev/null and b/docs/source/_static/images/general/model-evaluation-suite.gif differ diff --git a/docs/source/_static/images/general/nlp-checks.gif b/docs/source/_static/images/general/nlp-checks.gif new file mode 100644 index 0000000000..a69f66d94d Binary files /dev/null and b/docs/source/_static/images/general/nlp-checks.gif differ diff --git a/docs/source/_static/images/welcome/ci_cd_title.png b/docs/source/_static/images/welcome/ci_cd_title.png deleted file mode 100644 index 6deafec840..0000000000 Binary files a/docs/source/_static/images/welcome/ci_cd_title.png and /dev/null differ diff --git a/docs/source/_static/images/welcome/ci_tile.png b/docs/source/_static/images/welcome/ci_tile.png new file mode 100644 index 0000000000..00a70c0003 Binary files /dev/null and b/docs/source/_static/images/welcome/ci_tile.png differ diff --git a/docs/source/_static/images/welcome/deepchecks_continuous_validation_light.png b/docs/source/_static/images/welcome/deepchecks_continuous_validation_light.png new file mode 100644 index 0000000000..32abfb83a0 Binary files /dev/null and b/docs/source/_static/images/welcome/deepchecks_continuous_validation_light.png differ diff --git a/docs/source/_static/images/welcome/monitoring_tile.png b/docs/source/_static/images/welcome/monitoring_tile.png new file mode 100644 index 0000000000..215f5d2870 Binary files /dev/null and b/docs/source/_static/images/welcome/monitoring_tile.png differ diff --git a/docs/source/_static/images/welcome/monitoring_title.png b/docs/source/_static/images/welcome/monitoring_title.png deleted file mode 100644 index dc0f84d4c4..0000000000 Binary files a/docs/source/_static/images/welcome/monitoring_title.png and /dev/null differ diff --git a/docs/source/_static/images/welcome/research_title.png b/docs/source/_static/images/welcome/research_title.png deleted file mode 100644 index 43b5678416..0000000000 Binary files a/docs/source/_static/images/welcome/research_title.png and /dev/null differ diff --git a/docs/source/_static/images/welcome/testing_phases_in_pipeline.png b/docs/source/_static/images/welcome/testing_phases_in_pipeline.png deleted file mode 100644 index ed6b7163e2..0000000000 Binary files a/docs/source/_static/images/welcome/testing_phases_in_pipeline.png and /dev/null differ diff --git a/docs/source/_static/images/welcome/testing_phases_in_pipeline_with_tiles.png b/docs/source/_static/images/welcome/testing_phases_in_pipeline_with_tiles.png new file mode 100644 index 0000000000..02aecede4a Binary files /dev/null and b/docs/source/_static/images/welcome/testing_phases_in_pipeline_with_tiles.png differ diff --git a/docs/source/_static/images/welcome/testing_tile.png b/docs/source/_static/images/welcome/testing_tile.png new file mode 100644 index 0000000000..46527974fb Binary files /dev/null and b/docs/source/_static/images/welcome/testing_tile.png differ diff --git a/docs/source/conf.py b/docs/source/conf.py index 2652ea3ee7..25837b6558 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -443,7 +443,7 @@ def linkcode_resolve(domain, info): # Path to logo and favicon # -html_logo = "./_static/images/general/deepchecks_logo.svg" +html_logo = "./_static/images/general/deepchecks-testing-logo.svg" html_favicon = "./_static/favicons/favicon.ico" # If true, the reST sources are included in the HTML build as _sources/name. The default is True. @@ -466,6 +466,10 @@ def linkcode_resolve(domain, info): "version_match": version, "url_template": "https://docs.deepchecks.com/{version}/", }, + "external_links": [ + {"name": "Monitoring", "url": "https://docs.deepchecks.com/monitoring"}, + {"name": "CI", "url": "https://docs.deepchecks.com/stable/general/usage/ci_cd.html"} + ], "icon_links": [ { "name": "GitHub", @@ -474,7 +478,7 @@ def linkcode_resolve(domain, info): }, { "name": "Slack", - "url": "https://deepcheckscommunity.slack.com/join/shared_invite/zt-y28sjt1v-PBT50S3uoyWui_Deg5L_jg#/shared-invite/email", + "url": "https://deepchecks.com/slack", "icon": "fab fa-slack", }, { diff --git a/docs/source/general/concepts/when_should_you_use.rst b/docs/source/general/concepts/when_should_you_use.rst index fa709909a2..27344e6e02 100644 --- a/docs/source/general/concepts/when_should_you_use.rst +++ b/docs/source/general/concepts/when_should_you_use.rst @@ -23,7 +23,7 @@ Built-In Suites - API Reference Check the :mod:`deepchecks.tabular.suites` in the API reference for a list of all of the built-in suites for tabular data, :mod:`deepchecks.nlp.suites` for nlp data or -:mod:`deepchecks.vision.suites` for vision data (in beta release). +:mod:`deepchecks.vision.suites` for vision data. . diff --git a/docs/source/general/index.rst b/docs/source/general/index.rst index 1cfa9385b9..da661fe863 100644 --- a/docs/source/general/index.rst +++ b/docs/source/general/index.rst @@ -6,6 +6,10 @@ General Here you can find the key concepts, structure, recommended flow, and dive in to many of the deepchecks functionalities. +.. image:: /_static/images/general/checks-and-conditions.png + :alt: Deepchecks Testing Suite of Checks + :width: 50% + :align: center Concepts -------- diff --git a/docs/source/general/usage/ci_cd.rst b/docs/source/general/usage/ci_cd.rst index af6e28d150..f29a4b9c90 100644 --- a/docs/source/general/usage/ci_cd.rst +++ b/docs/source/general/usage/ci_cd.rst @@ -1,3 +1,5 @@ +.. _using_deepchecks_ci_cd: + ================================= Using Deepchecks In CI/CD ================================= diff --git a/docs/source/general/usage/showing_results.rst b/docs/source/general/usage/showing_results.rst index c585d8831d..4a0dbbe102 100644 --- a/docs/source/general/usage/showing_results.rst +++ b/docs/source/general/usage/showing_results.rst @@ -10,8 +10,10 @@ refer to the :ref:`exporting_deepchecks_results` guide. Structure: - :ref:`showing_results_main_methods` - - :ref:`show_method` - - :ref:`show_in_window_method` + + - :ref:`show_method` + - :ref:`show_in_window_method` + - :ref:`alternative_show_options_for_troubleshooting` diff --git a/docs/source/getting-started/installation.rst b/docs/source/getting-started/installation.rst index 007c75d2c5..887802e19c 100644 --- a/docs/source/getting-started/installation.rst +++ b/docs/source/getting-started/installation.rst @@ -66,11 +66,6 @@ Simply run the following command in a notebook cell Deepchecks For NLP ================== -.. note:: - Deepchecks' NLP subpackage is in **beta** release, and is available from PyPI, - use at your own discretion. `Github Issues `__ are - highly encouraged for feature requests and bug reports. - 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]`. @@ -87,11 +82,6 @@ Using Pip Deepchecks For Computer Vision =============================== -.. note:: - Deepchecks' Computer Vision subpackage is in **beta** release, and is available from PyPI, - use at your own discretion. `Github Issues `__ are - highly encouraged for feature requests and bug reports. - 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]`. diff --git a/docs/source/getting-started/welcome.rst b/docs/source/getting-started/welcome.rst index 31ae6fdfb4..1cd381a43a 100644 --- a/docs/source/getting-started/welcome.rst +++ b/docs/source/getting-started/welcome.rst @@ -1,32 +1,92 @@ -.. image:: /_static/images/general/deepchecks-logo-with-white-wide-back.png - :target: https://deepchecks.com/?utm_source=docs.deepchecks.com/stable&utm_medium=referral&utm_campaign=welcome - :alt: Deepchecks Logo +.. image:: /_static/images/welcome/deepchecks_continuous_validation_light.png + :alt: Deepchecks Continuous Validation: Testing, CI & Monitoring :align: center :width: 80% -========================= +.. _welcome_depchecks_testing: + +======================== Welcome to Deepchecks! -========================= +======================== -Deepchecks is a holistic tool for testing, validating and monitoring your machine learning models -and data, throughout the model's lifecycle. It enables you to identify problems with your -data quality, distributions, and model's performance with minimal effort. +`Deepchecks `__ is a holistic open-source solution for all of your AI & ML validation needs, +enabling you to thoroughly test your data and models from research to production. -See more info in the :ref:`Deepchecks Components for Continuous Validation ` -section, along with the direct links to the documentation of each component. +We invite you to: -.. _welcome__start_working: +- See the following :ref:`Deepchecks Components ` + section for more info about the Testing, CI, & Monitoring components and for links to their corresponding documentation. +- Go to the :ref:`welcome__start_with_deepchecks_monitoring` section to have it up and running quickly and see it in action. -Get Started with Deepchecks Testing -======================================== -.. image:: /_static/images/general/checks-and-conditions.png - :alt: Deepchecks Testing Suite of Checks +.. .. image:: /_static/images/general/checks-and-conditions.png +.. :alt: Deepchecks Testing Suite of Checks +.. :width: 65% +.. :align: center + +.. image:: /_static/images/general/model-evaluation-suite.gif + :alt: Deepchecks Suite Run :width: 65% :align: center + +.. _welcome__deepchecks_components: + +Deepchecks' Components for Continuous Validation +================================================== + +Deepchecks provides comprehensive support for your testing requirements, +from examining data integrity and assessing distributions, +to validating data splits, comparing models and evaluating their +performance across the model's entire development process. + +.. grid:: 1 + :gutter: 1 1 3 3 + + .. grid-item-card:: Testing Docs (here) + :link-type: ref + :link: welcome__start_with_deepchecks_testing + :img-top: /_static/images/welcome/testing_tile.png + :columns: 6 4 4 4 + + Tests during research and model development + + .. grid-item-card:: CI Docs + :link-type: ref + :link: using_deepchecks_ci_cd + :img-top: /_static/images/welcome/ci_tile.png + :columns: 6 4 4 4 + + Tests before deploying the model to production + + .. grid-item-card:: Monitoring Docs + :link-type: ref + :link: deepchecks-mon:welcome__start_with_deepchecks_monitoring + :img-top: /_static/images/welcome/monitoring_tile.png + :columns: 6 4 4 4 + + Tests and continuous monitoring during production + + +Deechecks' continuous validation approach is based on testing the ML models and data throughout their lifecycle +using the exact same checks, enabling a simple, elaborate and seamless experience for configuring and consuming the results. +Each phase has its relevant interfaces (e.g. visual outputs, python/json output results, alert configuration, push notifications, RCA, etc.) for +interacting with the test results. + +.. image:: /_static/images/welcome/testing_phases_in_pipeline_with_tiles.png + :alt: Phases for Continuous Validation of ML Models and Data + :align: center + +| + +.. _welcome__start_with_deepchecks_testing: + +Get Started with Deepchecks Testing +======================================== + + .. grid:: 1 :gutter: 3 @@ -121,52 +181,6 @@ Get Started with Deepchecks Testing :columns: 4 -.. _welcome__deepchecks_components: - -Deepchecks' Components -======================= - -.. grid:: 1 - :gutter: 3 - - .. grid-item-card:: Testing Docs (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:: CI Docs - :link-type: doc - :link: /general/usage/ci_cd - :img-top: /_static/images/welcome/ci_cd_title.png - :columns: 4 - - Tests before deploying the model to production - - .. grid-item-card:: Monitoring Docs - :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 - -Deepchecks accompanies you through various testing needs such as verifying your data's integrity, -inspecting its distributions, validating data splits, evaluating your model and comparing between different models, -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 - -| - -Deechecks' continuous validation approach is based on testing the ML models and data throughout the different phases -using the exact same checks, enabling a simple, elaborate and seamless experience for configuring and consuming the results. -Each phase has its relevant interfaces (e.g. visual outputs, output results to json, alert configuration, push notifications, RCA, etc.) for -interacting with the test results. .. _welcome__get_help: @@ -182,7 +196,7 @@ Get Help & Give Us Feedback - Post an issue or start a discussion on `Github Issues `__. - To contribute to the package, check out the `Contribution Guidelines `__ and join the - `contributors-q-and-a channel `__ on Slack, + `contributors-q-&-a channel `__ on Slack, or communicate with us via github issues. To support us, please give us a star on ⭐️ `Github `__ ⭐️, diff --git a/docs/source/nlp/index.rst b/docs/source/nlp/index.rst index ca1de33d7d..8e8c1956fe 100644 --- a/docs/source/nlp/index.rst +++ b/docs/source/nlp/index.rst @@ -13,6 +13,11 @@ Help us develop it further! You can provide feedback and suggestions as issues o `GitHub `__, or by joining our `Community Slack `__. +.. image:: /_static/images/general/nlp-checks.gif + :alt: Deepchecks NLP Check Results + :width: 50% + :align: center + .. _nlp__index_tutorials: Tutorials @@ -50,11 +55,11 @@ Checks Gallery Below in the full list of checks and suites available in the deepchecks nlp sub package. .. toctree:: + :hidden: :titlesonly: - :maxdepth: 0 + :maxdepth: 2 :caption: Checks Gallery auto_checks/data_integrity/index auto_checks/train_test_validation/index auto_checks/model_evaluation/index - diff --git a/docs/source/tabular/index.rst b/docs/source/tabular/index.rst index 7fad495f9e..07d5ab8ccd 100644 --- a/docs/source/tabular/index.rst +++ b/docs/source/tabular/index.rst @@ -9,6 +9,11 @@ Jump over to the :ref:`tabular__quickstarts` in the Tutorials section to get sta or visit the :ref:`getting-started__installation` for a full guide about how to set up your environment. +.. image:: /_static/images/general/model-evaluation-suite.gif + :alt: Deepchecks Suite Run + :width: 60% + :align: center + .. _tabular__index_tutorials: Tutorials @@ -49,8 +54,7 @@ Checks Gallery Below in the full list of checks and suites available in the deepchecks tabular sub package. .. toctree:: - :titlesonly: - :maxdepth: 0 + :maxdepth: 2 :caption: Checks Gallery auto_checks/data_integrity/index diff --git a/docs/source/vision/index.rst b/docs/source/vision/index.rst index 1116945495..7fb94f04c9 100644 --- a/docs/source/vision/index.rst +++ b/docs/source/vision/index.rst @@ -48,8 +48,7 @@ Checks Gallery Below in the full list of checks and suites available in the deepchecks vision sub package. .. toctree:: - :titlesonly: - :maxdepth: 0 + :maxdepth: 1 :caption: Checks Gallery auto_checks/data_integrity/index