torchcvnn


Nametorchcvnn JSON
Version 0.9.4 PyPI version JSON
download
home_pageNone
Summarytorchcvnn provides complex valued layers to be used with pytorch
upload_time2025-02-11 15:01:24
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9.10
licenseNone
keywords deep learning pytorch complex valued neural networks
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Complex-Valued Neural Networks (CVNN) - Pytorch

[![docs](https://github.com/torchcvnn/torchcvnn/actions/workflows/doc.yml/badge.svg)](https://torchcvnn.github.io/torchcvnn/) ![pytest](https://github.com/torchcvnn/torchcvnn/actions/workflows/test.yml/badge.svg) [![PyPI version](https://badge.fury.io/py/torchcvnn.svg)](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:torchcvnn/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.9.10",
    "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>, Quentin Gabot <quentin.gabot@centralesupelec.fr>",
    "download_url": "https://files.pythonhosted.org/packages/b0/b4/8c22bd79a91d08a9e8670f99182146b7e1859e4e021ff2bb77331d1b0618/torchcvnn-0.9.4.tar.gz",
    "platform": null,
    "description": "# Complex-Valued Neural Networks (CVNN) - Pytorch\n\n[![docs](https://github.com/torchcvnn/torchcvnn/actions/workflows/doc.yml/badge.svg)](https://torchcvnn.github.io/torchcvnn/) ![pytest](https://github.com/torchcvnn/torchcvnn/actions/workflows/test.yml/badge.svg) [![PyPI version](https://badge.fury.io/py/torchcvnn.svg)](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:torchcvnn/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.9.4",
    "project_urls": null,
    "split_keywords": [
        "deep learning",
        " pytorch",
        " complex valued neural networks"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "45df7ef2437362741c7f57af8aa7704c0bb900b200673479822531e06707a12f",
                "md5": "ef3960c966333fca3991b9124695411c",
                "sha256": "83bce045df3a1d4afe57301067f103c6af6ff25d2127b07f1fa25a06f930fb14"
            },
            "downloads": -1,
            "filename": "torchcvnn-0.9.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ef3960c966333fca3991b9124695411c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9.10",
            "size": 99992,
            "upload_time": "2025-02-11T15:01:23",
            "upload_time_iso_8601": "2025-02-11T15:01:23.463709Z",
            "url": "https://files.pythonhosted.org/packages/45/df/7ef2437362741c7f57af8aa7704c0bb900b200673479822531e06707a12f/torchcvnn-0.9.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b0b48c22bd79a91d08a9e8670f99182146b7e1859e4e021ff2bb77331d1b0618",
                "md5": "8bcc14c967b8542dd3a1a5ffc33d8672",
                "sha256": "29a79e8e3662952d3638486166ccf48b55c16dc49c9b9aa5c545167e13f336c7"
            },
            "downloads": -1,
            "filename": "torchcvnn-0.9.4.tar.gz",
            "has_sig": false,
            "md5_digest": "8bcc14c967b8542dd3a1a5ffc33d8672",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9.10",
            "size": 65062,
            "upload_time": "2025-02-11T15:01:24",
            "upload_time_iso_8601": "2025-02-11T15:01:24.868912Z",
            "url": "https://files.pythonhosted.org/packages/b0/b4/8c22bd79a91d08a9e8670f99182146b7e1859e4e021ff2bb77331d1b0618/torchcvnn-0.9.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-11 15:01:24",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "torchcvnn"
}
        
Elapsed time: 0.79326s