<img src="docs/source/flippers.png" width="255"/>
![GitHub last commit](https://img.shields.io/github/last-commit/liamtoran/flippers)
![PyPI](https://img.shields.io/pypi/v/flippers)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/flippers)
![Code Style](https://img.shields.io/badge/code%20style-black-black)
![Read the Docs](https://img.shields.io/readthedocs/flippers)
![GitHub](https://img.shields.io/github/license/liamtoran/flippers)
`flippers` is a Python library for weak supervision, which allows you to leverage your domain knowledge, heuristics and other weak supervision sources to generate high-quality labels for your training data.
# Features
`flippers` includes a number of features for weak supervision, including:
- Simple tools to analyse your labeling functions,
- Multiple label models including a from-scratch implementation of the label model used in the `snorkel` library and featuring enhanced ways to predict probabilities,
- An extensive [documentation](https://flippers.readthedocs.io/en/latest/) with [tutorials](https://github.com/liamtoran/flippers/tree/main/examples) and an [API reference](https://flippers.readthedocs.io/en/latest/reference/flippers.html).
# Installation
To install the latest version of `flippers`, simply run:
```bash
pip install flippers
```
# Quick Start
## Documentation
To quickly get started with `flippers`, you can begin by exploring the [documentation](https://flippers.readthedocs.io/en/latest/) and running through the [examples](hhttps://github.com/liamtoran/flippers/tree/main/examples) provided. The examples cover a variety of use cases and techniques, which can help you to get a feel for how to apply `flippers` to your own projects.
## Example
- Analyzing your labeling functions:
```python
analysis = flippers.analyis(L_train)
```
- Training a Label Model and doing inference:
```python
label_model = flippers.models.SnorkelModel(polarities, class_balances)
label_model.fit(L_train)
label_model.predict_proba(L)
```
# Discussion
## Troubleshooting
If you have any questions or issues with `flippers`, please consult the [documentation](https://flippers.readthedocs.io/en/latest/) or reach out in the [GitHub issues](https://github.com/liamtoran/flippers/issues) page for support.
## Contributing
`flippers` is an open-source project, and contributions are welcome!
## Related projects
- [wrench](https://github.com/JieyuZ2/wrench): A weak supervision library created by for benchmarking label models and weak supervision techniques. `flippers` uses its list of datasets as benchmarks.
- [snorkel](https://github.com/snorkel-team/snorkel): A cornerstone weak supervision library created by Snorkel in 2016, now sadly abandonned.
Raw data
{
"_id": null,
"home_page": null,
"name": "flippers",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "annotation,data,data labeling,data science,labeling,machine learning,weak supervision",
"author": null,
"author_email": "Liam Toran <liam.toran@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/12/57/f6017ec263301e9f001a404a65a0644a9fb5bcba8039e55cc37bf425bac8/flippers-0.0.1b4.tar.gz",
"platform": null,
"description": "<img src=\"docs/source/flippers.png\" width=\"255\"/>\n\n![GitHub last commit](https://img.shields.io/github/last-commit/liamtoran/flippers)\n![PyPI](https://img.shields.io/pypi/v/flippers)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/flippers)\n![Code Style](https://img.shields.io/badge/code%20style-black-black)\n![Read the Docs](https://img.shields.io/readthedocs/flippers)\n![GitHub](https://img.shields.io/github/license/liamtoran/flippers)\n\n`flippers` is a Python library for weak supervision, which allows you to leverage your domain knowledge, heuristics and other weak supervision sources to generate high-quality labels for your training data. \n\n# Features\n`flippers` includes a number of features for weak supervision, including:\n- Simple tools to analyse your labeling functions,\n- Multiple label models including a from-scratch implementation of the label model used in the `snorkel` library and featuring enhanced ways to predict probabilities,\n- An extensive [documentation](https://flippers.readthedocs.io/en/latest/) with [tutorials](https://github.com/liamtoran/flippers/tree/main/examples) and an [API reference](https://flippers.readthedocs.io/en/latest/reference/flippers.html).\n\n# Installation\nTo install the latest version of `flippers`, simply run:\n\n```bash\npip install flippers\n```\n\n# Quick Start \n## Documentation\nTo quickly get started with `flippers`, you can begin by exploring the [documentation](https://flippers.readthedocs.io/en/latest/) and running through the [examples](hhttps://github.com/liamtoran/flippers/tree/main/examples) provided. The examples cover a variety of use cases and techniques, which can help you to get a feel for how to apply `flippers` to your own projects. \n## Example\n- Analyzing your labeling functions:\n```python\nanalysis = flippers.analyis(L_train)\n```\n- Training a Label Model and doing inference:\n\n```python\nlabel_model = flippers.models.SnorkelModel(polarities, class_balances)\n\nlabel_model.fit(L_train)\n\nlabel_model.predict_proba(L)\n```\n\n# Discussion\n## Troubleshooting\nIf you have any questions or issues with `flippers`, please consult the [documentation](https://flippers.readthedocs.io/en/latest/) or reach out in the [GitHub issues](https://github.com/liamtoran/flippers/issues) page for support.\n\n\n## Contributing\n\n`flippers` is an open-source project, and contributions are welcome!\n\n## Related projects\n- [wrench](https://github.com/JieyuZ2/wrench): A weak supervision library created by for benchmarking label models and weak supervision techniques. `flippers` uses its list of datasets as benchmarks. \n- [snorkel](https://github.com/snorkel-team/snorkel): A cornerstone weak supervision library created by Snorkel in 2016, now sadly abandonned.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "`flippers` is a weak supervision library for creating high quality labels using your domain kownledge and weak supervision sources.",
"version": "0.0.1b4",
"project_urls": {
"Documentation": "https://github.com/liamtoran/flippers#readme",
"Issues": "https://github.com/liamtoran/flippers/issues",
"Source": "https://github.com/liamtoran/flippers"
},
"split_keywords": [
"annotation",
"data",
"data labeling",
"data science",
"labeling",
"machine learning",
"weak supervision"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1d14d067e9f7a8d331cb18bb32b91152ea79bf4bd5d8c4e20e8ed9b24980497f",
"md5": "7322e5eeefa6d0a666256afbf31cfc06",
"sha256": "2ea897908e7e0ff85aeed94ccf8b630a7577e2a01be35ba600a3c2f85222945f"
},
"downloads": -1,
"filename": "flippers-0.0.1b4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7322e5eeefa6d0a666256afbf31cfc06",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 18607,
"upload_time": "2023-06-07T03:30:01",
"upload_time_iso_8601": "2023-06-07T03:30:01.578444Z",
"url": "https://files.pythonhosted.org/packages/1d/14/d067e9f7a8d331cb18bb32b91152ea79bf4bd5d8c4e20e8ed9b24980497f/flippers-0.0.1b4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1257f6017ec263301e9f001a404a65a0644a9fb5bcba8039e55cc37bf425bac8",
"md5": "ce2d3f260755e6bc575392b8f7c9344e",
"sha256": "30bd82eeb20bdbbd8a219fc1769ec47157ea7eaf82ade45e909757b326da5ef3"
},
"downloads": -1,
"filename": "flippers-0.0.1b4.tar.gz",
"has_sig": false,
"md5_digest": "ce2d3f260755e6bc575392b8f7c9344e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 1507589,
"upload_time": "2023-06-07T03:30:04",
"upload_time_iso_8601": "2023-06-07T03:30:04.561245Z",
"url": "https://files.pythonhosted.org/packages/12/57/f6017ec263301e9f001a404a65a0644a9fb5bcba8039e55cc37bf425bac8/flippers-0.0.1b4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-07 03:30:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "liamtoran",
"github_project": "flippers#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "flippers"
}