Skip to content

Commit

Permalink
Added copyright to license and pypi installation to readme (#191)
Browse files Browse the repository at this point in the history
* added copyright to license and pypi installation to readme
  • Loading branch information
shir22 committed Nov 25, 2021
1 parent b06bd7b commit 080e3a3
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 15 deletions.
2 changes: 2 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
Deepchecks licensing terms
================================

Copyright (c) 2021 Deepchecks (https://www.deepchecks.com)

Deepchecks is licensed under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE Version 3
as published by the Free Software Foundation;

Expand Down
24 changes: 9 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
![pyVersions](https://img.shields.io/pypi/pyversions/deepchecks)
![pkgVersion](https://img.shields.io/pypi/v/deepchecks)
![build](https://github.com/deepchecks/deepchecks/actions/workflows/build.yml/badge.svg)
![coverage](https://deepchecks-public.s3.eu-west-1.amazonaws.com/deepchecks/coverage.svg)
![pylint](https://deepchecks-public.s3.eu-west-1.amazonaws.com/deepchecks/pylint.svg)

[comment]: <> "![coverage](https://deepchecks-public.s3.eu-west-1.amazonaws.com/deepchecks/coverage.svg)"
[comment]: <> "![pylint](https://deepchecks-public.s3.eu-west-1.amazonaws.com/deepchecks/pylint.svg)"

Deepchecks is a Python package for comprehensively validating your machine learning
models and data with minimal effort.
Expand All @@ -18,7 +19,7 @@ data integrity, distribution mismatches, and more.

## Key Concepts

#### Check
### Check
Each check enables you to inspect a specific aspect of your data and models.
They are the basic building block of the deepchecks package, covering all kinds of common issues,
such as: PerformanceOverfit, DataSampleLeakage, SingleFeatureContribution,
Expand All @@ -28,7 +29,7 @@ Each check can have two types of results:
2. A return value that can be used for validating the expected check results
(validations are typically done by adding a "condition" to the check, as explained below).

#### Condition
### Condition
A condition is a function that can be added to a Check, which returns a pass &#x2713;, fail &#x2716;
or warning &#x0021; result, intended for validation the Check's return value. An example for adding a condition would be:
```python
Expand All @@ -38,7 +39,7 @@ BoostingOverfit().add_condition_test_score_percent_decline_not_greater_than(thre
which will fail if there is a difference of more than 5% between the best score achieved on the test set during
the boosting iterations and the score achieved in the last iteration (the model's "original" score on the test set).

#### Suite
### Suite
An ordered collection of checks, that can have conditions added to them.
The Suite enables displaying a concluding report for all of the Checks that ran.
[Here](deepchecks/suites) you can find the [predefined existing suites](deepchecks/suites) and a code example demonstrating how to build
Expand All @@ -47,19 +48,12 @@ You can edit the preconfigured suites or build a suite of your own with a collec

## Installation

#### Using pip directly from the github tag
```bash
pip install git+https://github.com/deepchecks/deepchecks@0.0.8 #--user
```
Replacing "0.0.8" with the name of the latest tag.

#### Using pip with package wheel file
From the directory to which you have downloaded the wheel file, run:
### Using pip
```bash
pip install deepchecks-latest-tag-wheel.whl #--user
pip install deepchecks #--user
```

#### From source
### From source
First clone the repository and then install the package from inside the repository's directory:
```bash
git clone https://github.com/deepchecks/deepchecks.git
Expand Down

0 comments on commit 080e3a3

Please sign in to comment.