Skip to content

Commit

Permalink
improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
caiodallaqua committed Jan 23, 2024
1 parent 18abd85 commit 240c998
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 11 deletions.
7 changes: 0 additions & 7 deletions .vscode/settings.json

This file was deleted.

9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

A toolkit for day-to-day DS tasks such as using custom transformers or estimators.

Found a bug or have a feature request? [Open an issue](https://github.com/pier-digital/pier-ds-utils/issues/new/choose)!

## Usage

```python
Expand All @@ -21,14 +23,13 @@ predict_proba_selector = ds.estimator.PredictProbaSelector(...)

```bash
# pip
pip install git+https://github.com/pier-digital/pier-ds-utils.git@_version_
pip install git+https://github.com/pier-digital/pier-ds-utils@_version_

# poetry
poetry add git+https://github.com/pier-digital/pier-ds-utils.git@_version_
poetry add git+https://github.com/pier-digital/pier-ds-utils@_version_

# conda (must be in the virtual environment)
pip install git+https://github.com/pier-digital/pier-ds-utils.git@_version_
pip install git+https://github.com/pier-digital/pier-ds-utils@_version_
```

Replace `_version_` by the specific version you want to use. You can find them [here](https://github.com/pier-digital/pier-ds-utils/tags).

0 comments on commit 240c998

Please sign in to comment.