Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating Demo Notebooks for How-to-Guides #237

Merged
merged 5 commits into from
Dec 9, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This includes checks related to various types of issues, such as model performan
data integrity, distribution mismatches, and more.

<p align="center">
<img src="docs/images/check_suite_diagram.png" height="300">
<img src="docs/images/diagram.svg">
</p>

## Key Concepts
Expand Down Expand Up @@ -157,16 +157,16 @@ df_train, df_test = train_test_split(iris_df, stratify=iris_df[label_col], rando
To run an existing suite all you need to do is import the suite and run it -

```python
from deepchecks.suites import integrity_check_suite
integrity_suite = integrity_check_suite()
integrity_suite.run(train_dataset=df_train, test_dataset=df_test, check_datasets_policy='both')
from deepchecks.suites import integrity_suite
suite = integrity_check_suite()
suite.run(train_dataset=df_train, test_dataset=df_test, check_datasets_policy='both')
```
Which will result in printing the summary of the check conditions and then the visual outputs of all of the checks that
are in that suite.

### Example Notebooks
For usage examples, check out:
- [**deepchecks Quick Start Notebook**](./notebooks/examples/CheckSuite_Iris_Dataset.ipynb) - for a simple example notebook for working with checks and suites.
- [**Quickstart Notebook**](./notebooks/examples/quickstart_in_5_minutes.ipynb) - for running your first suite with a few lines of code.
- [**Example Checks Output Notebooks**](./notebooks/checks) - to see all of the existing checks and their usage examples.

## Communication
Expand Down
293 changes: 293 additions & 0 deletions docs/images/diagram.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.