diff --git a/README.md b/README.md index 7567f21afe..1ddef56728 100644 --- a/README.md +++ b/README.md @@ -35,11 +35,11 @@ Deepchecks is a holistic open-source solution for all of your AI & ML validation enabling you to thoroughly test your data and models from research to production. - + - - - Deepchecks continuous validation parts. + + + Deepchecks continuous validation parts. @@ -56,29 +56,6 @@ enabling you to thoroughly test your data and models from research to production

-## 🧮 How does it work? - -At its core, deepchecks includes a wide variety of built-in Checks, -for testing all types of data and model related issues. -These checks are implemented for various models and data types (Tabular, NLP, Vision), -and can easily be customized and expanded. - -The check results can be used to automatically make informed decisions -about your model's production-readiness, and for monitoring it over time in production. -The check results can be examined with visual reports (by saving them to an HTML file, or seeing them in Jupyter), -processed with code (using their pythonic / json output), and inspected and collaborated on with Deepchecks' dynamic UI -(for examining test results and for production monitoring). - - - ## 🧩 Components Deepchecks includes: @@ -126,18 +103,23 @@ Check out the full installation instructions for deepchecks testing [here](https #### Deepchecks Monitoring Installation -To use deepchecks for production monitoring, you can either use our SaaS service, or deploy a local instance in one line on Linux/MacOS (Windows is WIP!) with Docker: +To use deepchecks for production monitoring, you can either use our SaaS service, or deploy a local instance in one line on Linux/MacOS (Windows is WIP!) with Docker. +Create a new directory for the installation files, open a terminal within that directory and run the following: ``` -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/deepchecks/monitoring/main/deploy/deploy-oss.sh)" +pip install deepchecks-installer +deepchecks-installer monitoring-install ``` -This will automatically download the necessary dependencies and start the application locally. +This will automatically download the necessary dependencies, run the installation prcoess +and then start the application locally. + +The installation will take a few minutes. Then you can open the deployment url (default is http://localhost), +and start the system onboarding. Check out the full monitoring [open source installation & quickstart](https://docs.deepchecks.com/monitoring/stable/getting-started/deploy_self_host_open_source.html). + Note that the open source product is built such that each deployment supports monitoring of a single model. -Check out the full installation instructions for deepchecks monitoring [here](https://docs.deepchecks.com/monitoring/stable/installation/index.html). - ### 🏃‍♀️ Quickstarts @@ -173,7 +155,7 @@ suite_result.save_as_html() # replace this with suite_result.show() or suite_res The output will be a report that enables you to inspect the status and results of the chosen checks:

- +

@@ -186,13 +168,13 @@ The output will be a report that enables you to inspect the status and results o Jump right into the -[monitoring quickstart docs](https://docs.deepchecks.com/monitoring/stable/user-guide/tabular/auto_quickstarts/plot_quickstart.html) +[open source monitoring quickstart docs](https://docs.deepchecks.com/monitoring/stable/getting-started/deploy_self_host_open_source.html) to have it up and running on your data. You'll then be able to see the checks results over time, set alerts, and interact with the dynamic deepchecks UI that looks like this:

- +

@@ -208,7 +190,7 @@ Deepchecks managed CI & Testing management is currently in closed preview. [Book a demo](https://deepchecks.com/book-demo/) for more information about the offering.

- +

For building and maintaining your own CI process while utilizing Deepchecks Testing for it, @@ -216,6 +198,31 @@ check out our [docs for Using Deepchecks in CI/CD](https://docs.deepchecks.com/s + +## 🧮 How does it work? + +At its core, deepchecks includes a wide variety of built-in Checks, +for testing all types of data and model related issues. +These checks are implemented for various models and data types (Tabular, NLP, Vision), +and can easily be customized and expanded. + +The check results can be used to automatically make informed decisions +about your model's production-readiness, and for monitoring it over time in production. +The check results can be examined with visual reports (by saving them to an HTML file, or seeing them in Jupyter), +processed with code (using their pythonic / json output), and inspected and collaborated on with Deepchecks' dynamic UI +(for examining test results and for production monitoring). + + + +

@@ -250,6 +257,7 @@ processed with code (using their json output), and inspected and colloaborated u Optional conditions can be added to each check, to automatically validate whether it passed or not. ---> + ## 📜 Open Source vs Paid Deepchecks' projects (``deepchecks/deepchecks`` & ``deepchecks/monitoring``) are open source and are released under [AGPL 3.0](./LICENSE). diff --git a/docs/source/_static/images/general/model_evaluation_suite.gif b/docs/source/_static/images/general/model_evaluation_suite.gif deleted file mode 100644 index 74ad9d35b4..0000000000 Binary files a/docs/source/_static/images/general/model_evaluation_suite.gif and /dev/null differ diff --git a/docs/source/_static/images/readme/cont_validation_dark.png b/docs/source/_static/images/readme/cont_validation_dark.png deleted file mode 100644 index 8df750c5d5..0000000000 Binary files a/docs/source/_static/images/readme/cont_validation_dark.png and /dev/null differ diff --git a/docs/source/_static/images/readme/cont_validation_light.png b/docs/source/_static/images/readme/cont_validation_light.png deleted file mode 100644 index 8393a27f26..0000000000 Binary files a/docs/source/_static/images/readme/cont_validation_light.png and /dev/null differ diff --git a/docs/source/_static/images/readme/deepchecks_continuous_validation_dark.png b/docs/source/_static/images/readme/deepchecks_continuous_validation_dark.png new file mode 100644 index 0000000000..4df0d891e9 Binary files /dev/null and b/docs/source/_static/images/readme/deepchecks_continuous_validation_dark.png differ diff --git a/docs/source/_static/images/readme/deepchecks_continuous_validation_light.png b/docs/source/_static/images/readme/deepchecks_continuous_validation_light.png new file mode 100644 index 0000000000..32abfb83a0 Binary files /dev/null and b/docs/source/_static/images/readme/deepchecks_continuous_validation_light.png differ diff --git a/docs/source/_static/images/readme/model-evaluation-suite.gif b/docs/source/_static/images/readme/model-evaluation-suite.gif new file mode 100644 index 0000000000..b11de456d2 Binary files /dev/null and b/docs/source/_static/images/readme/model-evaluation-suite.gif differ