Metadata-Version: 2.1
Name: torchcvnn
Version: 0.2.1
Summary: torchcvnn provides complex valued layers to be used with pytorch
Author-email: Jeremy Fix <jeremy.fix@centralesupelec.fr>
Maintainer-email: Jeremy Fix <jeremy.fix@centralesupelec.fr>
Keywords: deep learning,pytorch,complex valued neural networks
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: torch>=2.0
Requires-Dist: numpy

# 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)

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 :

```
pip install git+ssh://git@github.com/jeremyfix/torchcvnn.git
```

## 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. 

## 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)
