# Complex-Valued Neural Networks (CVNN) - Pytorch
[](https://jeremyfix.github.io/torchcvnn/)  [](https://badge.fury.io/py/torchcvnn)
This is a library that uses [pytorch](https://pytorch.org) as a back-end for complex valued neural networks.
It was initially developed by Victor Dhédin and Jérémie Levi during their third year project at CentraleSupélec.
## Installation
To install the library, it is simple as :
```
python -m pip install torchcvnn
```
## Installation for developping
To install when developping the library, within a virtual envrionment, you can :
```
git clone git@github.com:jeremyfix/torchcvnn.git
python3 -m venv torchcvnn-venv
source torchcvnn-venv/bin/activate
python -m pip install -e torchcvnn
```
This will install torchcvnn in developper mode.
## Releasing a new version
To trigger the pipeline for a new release, you have to tag a commit and to push
it on the main branch
```
[main] git tag x.x.x
[main] git push --tags
```
This will trigger the `ci-cd.yml` pipeline which builds the distribution,
release it on github and on pypi.
Any commit that is not explicitely tagged with a version number does not trigger
the release ci-cd pipeline.
## Other projects
You might also be interested in some other projects:
Tensorflow based :
- [cvnn](https://github.com/NEGU93/cvnn) developed by colleagues from CentraleSupélec
Pytorch based :
- [cplxmodule](https://github.com/ivannz/cplxmodule)
- [complexPyTorch](https://github.com/wavefrontshaping/complexPyTorch)
Raw data
{
"_id": null,
"home_page": null,
"name": "torchcvnn",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Jeremy Fix <jeremy.fix@centralesupelec.fr>",
"keywords": "deep learning, pytorch, complex valued neural networks",
"author": null,
"author_email": "Jeremy Fix <jeremy.fix@centralesupelec.fr>",
"download_url": "https://files.pythonhosted.org/packages/26/d1/9eeed11bf43ede74bbd2823b8978048360f29ad916a493e99e7c964b5474/torchcvnn-0.5.0.tar.gz",
"platform": null,
"description": "# Complex-Valued Neural Networks (CVNN) - Pytorch\n\n[](https://jeremyfix.github.io/torchcvnn/)  [](https://badge.fury.io/py/torchcvnn)\n\nThis is a library that uses [pytorch](https://pytorch.org) as a back-end for complex valued neural networks.\n\nIt was initially developed by Victor Dh\u00e9din and J\u00e9r\u00e9mie Levi during their third year project at CentraleSup\u00e9lec. \n\n## Installation\n\nTo install the library, it is simple as :\n\n```\npython -m pip install torchcvnn\n```\n\n## Installation for developping\n\nTo install when developping the library, within a virtual envrionment, you can :\n\n```\ngit clone git@github.com:jeremyfix/torchcvnn.git\npython3 -m venv torchcvnn-venv\nsource torchcvnn-venv/bin/activate\npython -m pip install -e torchcvnn\n```\n\nThis will install torchcvnn in developper mode. \n\n## Releasing a new version\n\nTo trigger the pipeline for a new release, you have to tag a commit and to push\nit on the main branch \n\n```\n[main] git tag x.x.x\n[main] git push --tags\n```\n\nThis will trigger the `ci-cd.yml` pipeline which builds the distribution,\nrelease it on github and on pypi.\n\nAny commit that is not explicitely tagged with a version number does not trigger\nthe release ci-cd pipeline.\n\n## Other projects\n\nYou might also be interested in some other projects: \n\nTensorflow based : \n\n- [cvnn](https://github.com/NEGU93/cvnn) developed by colleagues from CentraleSup\u00e9lec\n\nPytorch based : \n\n- [cplxmodule](https://github.com/ivannz/cplxmodule)\n- [complexPyTorch](https://github.com/wavefrontshaping/complexPyTorch)\n",
"bugtrack_url": null,
"license": null,
"summary": "torchcvnn provides complex valued layers to be used with pytorch",
"version": "0.5.0",
"project_urls": null,
"split_keywords": [
"deep learning",
" pytorch",
" complex valued neural networks"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8db93665a0be0dffc61d9f77d0afa52422f1f9623416362b95f3f42d36c0ae19",
"md5": "fb1950f97776152f89ebac6cd0daa448",
"sha256": "dcebc8158bcaefc0c7ee306bad0037c7417442d819a92df14e1eac619b15d81b"
},
"downloads": -1,
"filename": "torchcvnn-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fb1950f97776152f89ebac6cd0daa448",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 53880,
"upload_time": "2024-05-06T19:13:27",
"upload_time_iso_8601": "2024-05-06T19:13:27.029516Z",
"url": "https://files.pythonhosted.org/packages/8d/b9/3665a0be0dffc61d9f77d0afa52422f1f9623416362b95f3f42d36c0ae19/torchcvnn-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "26d19eeed11bf43ede74bbd2823b8978048360f29ad916a493e99e7c964b5474",
"md5": "ae3e9691cc1948126916ee28cab36fa0",
"sha256": "64b5cd1444eea2df8e58a1ccd44811524babf6c0b54e06dc819a87b2b86cc85f"
},
"downloads": -1,
"filename": "torchcvnn-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "ae3e9691cc1948126916ee28cab36fa0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 31278,
"upload_time": "2024-05-06T19:13:28",
"upload_time_iso_8601": "2024-05-06T19:13:28.157702Z",
"url": "https://files.pythonhosted.org/packages/26/d1/9eeed11bf43ede74bbd2823b8978048360f29ad916a493e99e7c964b5474/torchcvnn-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-06 19:13:28",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "torchcvnn"
}
JSON