Name | fugw JSON |
Version |
0.1.0
JSON |
| download |
home_page | |
Summary | A collection of gpu-compatible solvers for fused unbalanced gromov-wasserstein optimization problems |
upload_time | 2023-03-19 17:09:12 |
maintainer | |
docs_url | None |
author | |
requires_python | >=3.7 |
license | |
keywords |
optimal transport
gromov wasserstein
solver
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# Fused Unbalanced Gromov-Wasserstein for Python
![build](https://img.shields.io/github/actions/workflow/status/alexisthual/fugw/unit_tests.yml?event=push&style=for-the-badge)
![python version](https://img.shields.io/badge/python-3.7_|_3.8_|_3.9_|_3.10_|_3.11-blue?style=for-the-badge)
![license](https://img.shields.io/github/license/alexisthual/fugw?style=for-the-badge)
![code style](https://img.shields.io/badge/code_style-black-black?style=for-the-badge)
This package implements multiple GPU-compatible PyTorch solvers
to the Fused Unbalanced Gromov-Wasserstein optimal transport problem.
**This package is under active development. There is no guarantee that the API and solvers
won't change in the near future.**
## Installation
**To install this package, make sure you have an up-to-date version of** `pip`.
### From PyPI
In a dedicated Python env, run:
```bash
pip install fugw
```
### From source
```bash
git clone https://github.com/alexisthual/fugw.git
cd fugw
```
In a dedicated Python env, run:
```bash
pip install -e .
```
Contributors should also install the development dependencies
in order to test and automatically format their contributions.
```bash
pip install -e ".[dev]"
pre-commit install
```
Tests run on CPU and GPU, depending on the configuration of your machine.
You can run them with:
```bash
pytest
```
## Citing this work
If this package was useful to you, please cite it in your work:
```bibtex
@article{Thual-2022-fugw,
title={Aligning individual brains with Fused Unbalanced Gromov-Wasserstein},
author={Thual, Alexis and Tran, Huy and Zemskova, Tatiana and Courty, Nicolas and Flamary, RĂ©mi and Dehaene, Stanislas and Thirion, Bertrand},
publisher={arXiv},
doi={10.48550/ARXIV.2206.09398},
url={https://arxiv.org/abs/2206.09398},
year={2022},
copyright={Creative Commons Attribution 4.0 International}
}
```
Raw data
{
"_id": null,
"home_page": "",
"name": "fugw",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "optimal transport,gromov wasserstein,solver",
"author": "",
"author_email": "Alexis Thual <alexisthual@gmail.com>, Huy Tran <quang-huy.tran@univ-ubs.fr>",
"download_url": "https://files.pythonhosted.org/packages/25/a6/c6be532076112d3bc49593c90401c233fc4dffeba3f4b7abb2d4759b9806/fugw-0.1.0.tar.gz",
"platform": null,
"description": "# Fused Unbalanced Gromov-Wasserstein for Python\n\n![build](https://img.shields.io/github/actions/workflow/status/alexisthual/fugw/unit_tests.yml?event=push&style=for-the-badge)\n![python version](https://img.shields.io/badge/python-3.7_|_3.8_|_3.9_|_3.10_|_3.11-blue?style=for-the-badge)\n![license](https://img.shields.io/github/license/alexisthual/fugw?style=for-the-badge)\n![code style](https://img.shields.io/badge/code_style-black-black?style=for-the-badge)\n\nThis package implements multiple GPU-compatible PyTorch solvers\nto the Fused Unbalanced Gromov-Wasserstein optimal transport problem.\n\n**This package is under active development. There is no guarantee that the API and solvers\nwon't change in the near future.**\n\n## Installation\n\n**To install this package, make sure you have an up-to-date version of** `pip`.\n\n### From PyPI\n\nIn a dedicated Python env, run:\n\n```bash\npip install fugw\n```\n\n### From source\n\n```bash\ngit clone https://github.com/alexisthual/fugw.git\ncd fugw\n```\n\nIn a dedicated Python env, run:\n\n```bash\npip install -e .\n```\n\nContributors should also install the development dependencies\nin order to test and automatically format their contributions.\n\n```bash\npip install -e \".[dev]\"\npre-commit install\n```\n\nTests run on CPU and GPU, depending on the configuration of your machine.\nYou can run them with:\n\n```bash\npytest\n```\n\n## Citing this work\n\nIf this package was useful to you, please cite it in your work:\n\n```bibtex\n@article{Thual-2022-fugw,\n title={Aligning individual brains with Fused Unbalanced Gromov-Wasserstein},\n author={Thual, Alexis and Tran, Huy and Zemskova, Tatiana and Courty, Nicolas and Flamary, R\u00e9mi and Dehaene, Stanislas and Thirion, Bertrand},\n publisher={arXiv},\n doi={10.48550/ARXIV.2206.09398},\n url={https://arxiv.org/abs/2206.09398},\n year={2022},\n copyright={Creative Commons Attribution 4.0 International}\n}\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "A collection of gpu-compatible solvers for fused unbalanced gromov-wasserstein optimization problems",
"version": "0.1.0",
"split_keywords": [
"optimal transport",
"gromov wasserstein",
"solver"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c278258a0b2aa49b96d200eda0f6b01820b1c08c976528ef7a1544115b6629cf",
"md5": "c1cf88764338580cd236400f06b80fb6",
"sha256": "3840703563eecf105b2f6576e2a542a4f70152c6d0b02c6fe2349d9add648c9f"
},
"downloads": -1,
"filename": "fugw-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c1cf88764338580cd236400f06b80fb6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 32494,
"upload_time": "2023-03-19T17:09:09",
"upload_time_iso_8601": "2023-03-19T17:09:09.650771Z",
"url": "https://files.pythonhosted.org/packages/c2/78/258a0b2aa49b96d200eda0f6b01820b1c08c976528ef7a1544115b6629cf/fugw-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "25a6c6be532076112d3bc49593c90401c233fc4dffeba3f4b7abb2d4759b9806",
"md5": "dd25245762b5d46b15faba8358aa89cb",
"sha256": "86260883805792422cb7ae353e45f5a75559c25dab9c077af5cf26f4a9b25a13"
},
"downloads": -1,
"filename": "fugw-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "dd25245762b5d46b15faba8358aa89cb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 1005674,
"upload_time": "2023-03-19T17:09:12",
"upload_time_iso_8601": "2023-03-19T17:09:12.220124Z",
"url": "https://files.pythonhosted.org/packages/25/a6/c6be532076112d3bc49593c90401c233fc4dffeba3f4b7abb2d4759b9806/fugw-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-19 17:09:12",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "fugw"
}