# FanFAIR
Semi-automatic assessment of datasets fairness
## What is FanFAIR
FanFAIR is a rule-based approach based on fuzzy logic able to calculate some fairness metrics over a dataset and combine them into a single score, enabling a semi-automatic evaluation of a dataset in algorithmic fairness research.
## Using FanFAIR
FanFAIR is designed to be as automatic as possible. However, two metrics (quality, compliance) require human intervention. Here is an example of analysis performed with FanFAIR:
```
from fanfair import FanFAIR
FF = FanFAIR(dataset="myfile.csv", target_column="output")
FF.set_compliance( {"data_protection_law": True,
"copyright_law": True,
"medical_law": True,
"non_discrimination_law": False,
"ethics": False})
FF.set_quality(0.9)
FF.produce_report()
```
The analysis is automatically performed by calling the ```produce_report``` method, which generates two main figures: the gauge with the overall fairness score (from 0% to 100%), and the plots of the linguistic variables of the fuzzy model, which provide a summary of the metrics for the dataset's fairenss features.
## Citing FanFAIR
If you find FanFAIR useful for your research, please cite our project as follows:
> Gallese C., Scantamburlo T., Manzoni L., Nobile M.S.: Investigating Semi-Automatic Assessment of Data Sets Fairness by Means of Fuzzy Logic, Proceedings of the 20th IEEE Conference on Computational Intelligence in Bioinformatics and Computational Biology (IEEE CIBCB 2023), 2023
If you need additional information, or want to see additional metrics implemented in FanFAIR, please feel free to contact Dr. Chiara Gallese (chiara.gallese@unito.it).
## Acknowledgements
Raw data
{
"_id": null,
"home_page": "https://github.com/aresio/FanFAIR",
"name": "FanFAIR",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "fuzzy logic, dataset analysis, dataset fairness",
"author": "Chiara Gallese, Marco S. Nobile",
"author_email": "marco.nobile@unive.it",
"download_url": "https://files.pythonhosted.org/packages/85/89/c47f6d38d170ba007889b6aebc7ae2803a633e5b2bf65c55550fa65b3743/fanfair-1.0.2.tar.gz",
"platform": null,
"description": "# FanFAIR\r\nSemi-automatic assessment of datasets fairness\r\n\r\n## What is FanFAIR\r\nFanFAIR is a rule-based approach based on fuzzy logic able to calculate some fairness metrics over a dataset and combine them into a single score, enabling a semi-automatic evaluation of a dataset in algorithmic fairness research.\r\n\r\n## Using FanFAIR\r\nFanFAIR is designed to be as automatic as possible. However, two metrics (quality, compliance) require human intervention. Here is an example of analysis performed with FanFAIR:\r\n\r\n```\r\nfrom fanfair import FanFAIR\r\n\r\nFF = FanFAIR(dataset=\"myfile.csv\", target_column=\"output\")\r\nFF.set_compliance( {\"data_protection_law\": True,\r\n \"copyright_law\": True,\r\n \"medical_law\": True,\r\n \"non_discrimination_law\": False,\r\n \"ethics\": False})\r\nFF.set_quality(0.9)\r\nFF.produce_report()\r\n```\r\n\r\nThe analysis is automatically performed by calling the ```produce_report``` method, which generates two main figures: the gauge with the overall fairness score (from 0% to 100%), and the plots of the linguistic variables of the fuzzy model, which provide a summary of the metrics for the dataset's fairenss features.\r\n\r\n\r\n## Citing FanFAIR \r\nIf you find FanFAIR useful for your research, please cite our project as follows:\r\n\r\n> Gallese C., Scantamburlo T., Manzoni L., Nobile M.S.: Investigating Semi-Automatic Assessment of Data Sets Fairness by Means of Fuzzy Logic, Proceedings of the 20th IEEE Conference on Computational Intelligence in Bioinformatics and Computational Biology (IEEE CIBCB 2023), 2023 \r\n\r\nIf you need additional information, or want to see additional metrics implemented in FanFAIR, please feel free to contact Dr. Chiara Gallese (chiara.gallese@unito.it). \r\n\r\n## Acknowledgements\r\n\r\n",
"bugtrack_url": null,
"license": "LICENSE.txt",
"summary": "FanFAIR, semi-automatic assessment of datasets fairness",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/aresio/FanFAIR"
},
"split_keywords": [
"fuzzy logic",
" dataset analysis",
" dataset fairness"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8e775cf23dafd6e9ec268c6ea8dde90589da50e2c057443a3c5e0ddc55bf08bf",
"md5": "2fe5aad795a267ef7077674f85779998",
"sha256": "e3a45ad8545ea1941c6191c9724be779ffb87b9556ee17c804e93a6d66858cc7"
},
"downloads": -1,
"filename": "FanFAIR-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2fe5aad795a267ef7077674f85779998",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10284,
"upload_time": "2024-06-16T19:24:43",
"upload_time_iso_8601": "2024-06-16T19:24:43.999548Z",
"url": "https://files.pythonhosted.org/packages/8e/77/5cf23dafd6e9ec268c6ea8dde90589da50e2c057443a3c5e0ddc55bf08bf/FanFAIR-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8589c47f6d38d170ba007889b6aebc7ae2803a633e5b2bf65c55550fa65b3743",
"md5": "af2135f61ba971c8794407db9279986e",
"sha256": "cf13fca094a3a8f56dc4d2042134e162141a7124ab2a93d249945b8684d9496a"
},
"downloads": -1,
"filename": "fanfair-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "af2135f61ba971c8794407db9279986e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9970,
"upload_time": "2024-06-16T19:24:45",
"upload_time_iso_8601": "2024-06-16T19:24:45.770301Z",
"url": "https://files.pythonhosted.org/packages/85/89/c47f6d38d170ba007889b6aebc7ae2803a633e5b2bf65c55550fa65b3743/fanfair-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-16 19:24:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aresio",
"github_project": "FanFAIR",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fanfair"
}
JSON
