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

Update the README #18

Merged
merged 1 commit into from
Mar 1, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,31 @@

# Label Shift

Python library for *label shift* (known as prior probability shift, target shift) and *quantification* (estimating the class prevalences in an unlabeled data set under the prior probability shift assumption).
Python library for *quantification* (estimating the class prevalence in an unlabeled data set) under the prior probability shift assumption.

This module is created with two purposes in mind:
- easily apply state-of-the-art quantification algorithms to the real problems,
- benchmark novel quantification algorithms against others.

It is compatible with any classifier using any machine learning framework.

Contributions are very welcome! Please, check our [Contribution guide](CONTRIBUTING.md).
The code inside was used to run the experiments in [our preprint](https://arxiv.org/abs/2302.09159), which can be cited as:
```
@misc{https://doi.org/10.48550/arxiv.2302.09159,
doi = {10.48550/ARXIV.2302.09159},
url = {https://arxiv.org/abs/2302.09159},
author = {Ziegler, Albert and Czyż, Paweł},
title = {Bayesian Quantification with Black-Box Estimators},
publisher = {arXiv},
year = {2023}
}
```

## Installation
Currently the module is in early development stage and is not ready to be installed. It does not have proper documentation either. We hope to change it soon – thank you for your patience!

## Contributions
Contributions are very welcome! Please, check our [Contribution guide](CONTRIBUTING.md).