Skip to main content

A neural network framework supporting complex-valued neural networks

Project description

CVNN_Jamie: Complex-Valued Neural Network Framework

CVNN_Jamie is a Python library for building and training complex-valued neural networks. It provides modular layers, a flexible Sequential model, a wide range of complex activation functions, and custom initialisation methods. Designed for research and experimentation with complex-valued data and models.

Features

  • Complex-valued layers (Dense, Activation, etc.)
  • Modular and extensible design
  • Custom activation functions and derivatives
  • Multiple initialisation methods (including custom/phase-constrained)
  • Easy integration with NumPy
  • Simple Sequential API for stacking layers and activations
  • Full backpropagation and training support

Installation

Install from PyPI:

pip install CVNN_Jamie

Or from source:

pip install -r requirements.txt

Model API: Sequential

You can easily build single-layer or multilayer networks using the Sequential model (import from cvnn):

Single-Layer Network

from cvnn import Sequential
from cvnn.layers import ComplexDense
from cvnn.activations import complex_relu
import numpy as np

model = Sequential([
	ComplexDense(input_dim=4, output_dim=2),
	complex_relu
])
x = np.random.randn(1, 4) + 1j * np.random.randn(1, 4)
out = model.forward(x)
print("Single-layer output:", out)

Multilayer Network

from cvnn import Sequential
from cvnn.layers import ComplexDense
from cvnn.activations import complex_relu, complex_tanh
import numpy as np

model = Sequential([
	ComplexDense(input_dim=4, output_dim=8),
	complex_relu,
	ComplexDense(input_dim=8, output_dim=2),
	complex_tanh
])
x = np.random.randn(1, 4) + 1j * np.random.randn(1, 4)
out = model.forward(x)
print("Multilayer output:", out)

Training (Demo: 1-layer, MSE loss, SGD)

from cvnn import Sequential
from cvnn.layers import ComplexDense
import numpy as np

# Dummy data: learn identity mapping
x = np.random.randn(10, 2) + 1j * np.random.randn(10, 2)
y = x.copy()
model = Sequential([
	ComplexDense(input_dim=2, output_dim=2)
])
model.fit(x, y, epochs=50, lr=0.01)

Complex-Valued Neural Network (CVNN) Framework

This library provides a framework for building complex-valued neural networks in Python. It includes core modules for layers, activations, and operations that support complex numbers.

Features

  • Complex-valued layers (Dense, Activation, etc.)
  • Modular and extensible design
  • Easy integration with NumPy

Getting Started

Install requirements:

pip install -r requirements.txt

Example Usage

ComplexDense Layer with Custom Initialisation

from cvnn.layers import ComplexDense
from cvnn.activations import complex_glorot_uniform, jamie
import numpy as np

# Use Glorot uniform for weights, jamie for bias
layer = ComplexDense(input_dim=4, output_dim=2, weight_init=complex_glorot_uniform, bias_init=jamie)
x = np.random.randn(1, 4) + 1j * np.random.randn(1, 4)
out = layer.forward(x)
print(out)

Using Activation Functions

from cvnn.activations import complex_relu, complex_sigmoid, complex_tanh, modrelu

z = np.array([1+2j, -1-2j, 0+0j, -3+4j])
print("ReLU:", complex_relu(z))
print("Sigmoid (separable):", complex_sigmoid(z))
print("Sigmoid (fully complex):", complex_sigmoid(z, fully_complex=True))
print("Tanh (separable):", complex_tanh(z))
print("Tanh (fully complex):", complex_tanh(z, fully_complex=True))
print("modReLU:", modrelu(z, bias=0.5))

Using Initialisation Methods Directly

from cvnn.activations import complex_zeros, complex_ones, complex_normal, complex_glorot_uniform, complex_he_normal, jamie

w = complex_zeros((3, 2))
b = jamie((1, 2))
print("Zeros init:", w)
print("Jamie init:", b)

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

CVNN_Jamie-0.2.0.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

CVNN_Jamie-0.2.0-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

Details for the file CVNN_Jamie-0.2.0.tar.gz.

File metadata

  • Download URL: CVNN_Jamie-0.2.0.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.2

File hashes

Hashes for CVNN_Jamie-0.2.0.tar.gz
Algorithm Hash digest
SHA256 ea111287c2a99020a17b2bf57ce807f132e6f4ab5f23b3aaf259482d49812b03
MD5 5c7e68e8551acdee0ea8e9ef34ab186e
BLAKE2b-256 4c1acb2da20161f9a837fb894db9a8220ca8ffb5733d6236bd029fa14f5694db

See more details on using hashes here.

File details

Details for the file CVNN_Jamie-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: CVNN_Jamie-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 9.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.2

File hashes

Hashes for CVNN_Jamie-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4f6422f10176fd90f2d53c9d43ce806912dde1c1b17838a01575786f351bb261
MD5 8912ded442b9915955f624d796346e29
BLAKE2b-256 d9a0574761108e100987a2c66ec495e5dca4f36227722a493d84a330940f606c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page