Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jeremyfix/torchcvnn

Pytorch layers for Complex Valued Neural Networks
https://github.com/jeremyfix/torchcvnn

complex-neural-networks complex-valued-neural-networks neural-networks python python3 pytorch

Last synced: 5 days ago
JSON representation

Pytorch layers for Complex Valued Neural Networks

Host: GitHub
URL: https://github.com/jeremyfix/torchcvnn
Owner: jeremyfix
License: mit
Created: 2023-09-30T16:11:27.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-05-07T17:09:37.000Z (6 months ago)
Last Synced: 2024-10-12T18:14:44.855Z (25 days ago)
Topics: complex-neural-networks, complex-valued-neural-networks, neural-networks, python, python3, pytorch
Language: Python
Homepage: https://jeremyfix.github.io/torchcvnn/
Size: 2.15 MB
Stars: 5
Watchers: 3
Forks: 2
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Complex-Valued Neural Networks (CVNN) - Pytorch

[![docs](https://github.com/jeremyfix/torchcvnn/actions/workflows/doc.yml/badge.svg)](https://jeremyfix.github.io/torchcvnn/) ![pytest](https://github.com/jeremyfix/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 [email protected]: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)