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.

Sign up for GitHub

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

Jump to bottom

updated readme #208

Merged
merged 9 commits into from
Nov 30, 2021
Merged

updated readme #208

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ce9b15c
updated_readme
Nov 30, 2021
13b63e9
updated_readme
Nov 30, 2021
6b9f6c7
updated_readme
Nov 30, 2021
03d5e2f
Merge branch 'main' of https://github.com/deepchecks/MLChecks into ML…
Nov 30, 2021
998db22
updated_readme
Nov 30, 2021
7d7cf02
updated_readme
Nov 30, 2021
1834d88
updated_readme
Nov 30, 2021
3977ef3
updated_readme
Nov 30, 2021
133024d
Merge branch 'main' of https://github.com/deepchecks/MLChecks into ML…
Nov 30, 2021
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
20 changes: 6 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,20 +51,13 @@ pip install deepchecks #--user
```

### From source
First clone the repository and then install the package from inside the repository's directory:
For latest commit:
```bash
git clone https://github.com/deepchecks/deepchecks.git
cd deepchecks
# for installing stable tag version and not the latest commit to main
git checkout tags/<name_of_latest_tag>
pip install git+https://github.com/deepchecks/deepchecks.git
```
and then either:
For stable tag:
```bash
pip install .
```
or
```bash
python setup.py install
pip install git+https://github.com/deepchecks/deepchecks.git@<tag_name>
JKL98ISR marked this conversation as resolved.
Show resolved Hide resolved
```

## Are You Ready to Start Checking?
Expand Down Expand Up @@ -139,9 +132,8 @@ from sklearn.datasets import load_iris
```
```python
iris_df = load_iris(return_X_y=False, as_frame=True)['frame']
train_len = round(0.67*len(iris_df))
df_train = iris_df[:train_len]
df_test = iris_df[train_len:]
label_col = 'target'
df_train, df_test = train_test_split(iris_df, stratify=iris_df[label_col], random_state=0)
```
To run an existing suite all you need to do is import the suite and run it -

Expand Down