| Name | gnnfairviz JSON |
| Version |
0.0.1.post1
JSON |
| download |
| home_page | None |
| Summary | Official implementation of GNNFairViz |
| upload_time | 2024-07-07 10:28:27 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <=3.11,>=3.8 |
| license | MIT License Copyright (c) 2024 Xinwu Ye Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
fairness
visual analysis
graph neural networks
jupyter notebook
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# GNNFairViz
 
## Overview
GNNFairViz is a visualization tool designed to provide insights into the fairness of Graph Neural Networks from the perspective of data.
## Installation
You can install GNNFairViz using pip or from source.
### Using pip
```bash
pip install gnnfairviz
```
### From Source
```bash
git clone https://github.com/xinwuye/GNNFairViz.git
cd GNNFairViz
pip install .
```
## Usage
Examples of how to use the package can be found in the `evaluation/cases` folder.
## Features
- Support customizing and inspecting fairness through various
viewpoints.
- Provide clues and interactions for node selection to analyze how
they affect model bias.
- Allow diagnosing GNN fairness issues in an interactive manner.
## Contributing
We welcome contributions! Follow these steps to set up your development environment and contribute to the project.
### Setting Up the Development Environment
```bash
git clone https://github.com/xinwuye/GNNFairViz.git
cd GNNFairViz
poetry install
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contact
For questions or support, please contact:
- **Email**: xwye23@m.fudan.edu.cn
- **GitHub Issues**: [GitHub Issues](https://github.com/xinwuye/GNNFairViz/issues)
## Credits
This project uses and adapts code from the following repositories:
- [CSC591_Community_Detection by imabhishekl](https://github.com/imabhishekl/CSC591_Community_Detection)
- [NoLiES by leitte](https://github.com/leitte/NoLiES)
- [PyGDebias by yushundong](https://github.com/yushundong/PyGDebias)
Raw data
{
"_id": null,
"home_page": null,
"name": "gnnfairviz",
"maintainer": null,
"docs_url": null,
"requires_python": "<=3.11,>=3.8",
"maintainer_email": null,
"keywords": "fairness, visual analysis, graph neural networks, Jupyter notebook",
"author": null,
"author_email": "Xinwu Ye <yexw0403@foxmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e0/db/22ea607cfcc4e5bc1851d519856b894a19feceaf6aecc2de42429661bb3b/gnnfairviz-0.0.1.post1.tar.gz",
"platform": null,
"description": "# GNNFairViz\n\n \n\n## Overview\n\nGNNFairViz is a visualization tool designed to provide insights into the fairness of Graph Neural Networks from the perspective of data. \n\n## Installation\n\nYou can install GNNFairViz using pip or from source.\n\n### Using pip\n\n```bash\npip install gnnfairviz\n```\n\n### From Source\n\n```bash\ngit clone https://github.com/xinwuye/GNNFairViz.git\ncd GNNFairViz\npip install .\n```\n\n## Usage\n\nExamples of how to use the package can be found in the `evaluation/cases` folder.\n\n## Features\n\n- Support customizing and inspecting fairness through various\nviewpoints.\n- Provide clues and interactions for node selection to analyze how\nthey affect model bias.\n- Allow diagnosing GNN fairness issues in an interactive manner.\n\n## Contributing\n\nWe welcome contributions! Follow these steps to set up your development environment and contribute to the project.\n\n### Setting Up the Development Environment\n\n```bash\ngit clone https://github.com/xinwuye/GNNFairViz.git\ncd GNNFairViz\npoetry install\n```\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Contact\n\nFor questions or support, please contact:\n\n- **Email**: xwye23@m.fudan.edu.cn\n- **GitHub Issues**: [GitHub Issues](https://github.com/xinwuye/GNNFairViz/issues)\n\n## Credits\n\nThis project uses and adapts code from the following repositories:\n\n- [CSC591_Community_Detection by imabhishekl](https://github.com/imabhishekl/CSC591_Community_Detection)\n- [NoLiES by leitte](https://github.com/leitte/NoLiES)\n- [PyGDebias by yushundong](https://github.com/yushundong/PyGDebias)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Xinwu Ye Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Official implementation of GNNFairViz",
"version": "0.0.1.post1",
"project_urls": null,
"split_keywords": [
"fairness",
" visual analysis",
" graph neural networks",
" jupyter notebook"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "85bab2bb8ffeddafc4538a5b6d693365d978a2b769b38520f048728d4fb6ed27",
"md5": "490e5f6406570d93a4e8058b21d181b4",
"sha256": "0e983bffc27f5ad615448faafb5bb3932a4144d5a137d768210d45f028983dd7"
},
"downloads": -1,
"filename": "gnnfairviz-0.0.1.post1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "490e5f6406570d93a4e8058b21d181b4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<=3.11,>=3.8",
"size": 34780,
"upload_time": "2024-07-07T10:28:24",
"upload_time_iso_8601": "2024-07-07T10:28:24.253789Z",
"url": "https://files.pythonhosted.org/packages/85/ba/b2bb8ffeddafc4538a5b6d693365d978a2b769b38520f048728d4fb6ed27/gnnfairviz-0.0.1.post1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e0db22ea607cfcc4e5bc1851d519856b894a19feceaf6aecc2de42429661bb3b",
"md5": "05eee127c94cb126d23f9b0f1db178c3",
"sha256": "aaa910ac94e03c0551a24f4f926007eb3be45829a14eb8429c07f1a6f057789b"
},
"downloads": -1,
"filename": "gnnfairviz-0.0.1.post1.tar.gz",
"has_sig": false,
"md5_digest": "05eee127c94cb126d23f9b0f1db178c3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<=3.11,>=3.8",
"size": 1442808,
"upload_time": "2024-07-07T10:28:27",
"upload_time_iso_8601": "2024-07-07T10:28:27.609004Z",
"url": "https://files.pythonhosted.org/packages/e0/db/22ea607cfcc4e5bc1851d519856b894a19feceaf6aecc2de42429661bb3b/gnnfairviz-0.0.1.post1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-07 10:28:27",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "gnnfairviz"
}
