Skip to main content

A PyTorch module for Liquid Neurons

Project description

liquidnn

liquidnn is a PyTorch library for Liquid Neural Networks (LNNs), including multi-layer networks built from liquid neurons.
This library provides an easy interface to use liquid dynamics in your neural networks without needing to handle the underlying neurons directly.


Disclaimer

This library is intended for learning and research purposes only. It is not optimized for production use.


Installation

pip install liquidnn


Usage

import torch
from liquidnn import LiquidNeuralNetwork

# Example: batch=2, seq_len=5, input_size=10
x = torch.randn(2, 5, 10)

# Initialize a multi-layer liquid neural network
model = LiquidNeuralNetwork(
    input_size=10,
    hidden_size=20,
    num_layers=2,          # number of stacked liquid layers
    tau=0.5,               # temporal integration factor
    scaling_factor_W=0.05, # weight scaling factor
    scaling_factor_U=0.05,
    scaling_factor_alpha=0.05
)

# Forward pass
out = model(x)
print(out.shape)  # Expected: torch.Size([2, 20])



Parameters

LiquidNeuralNetwork:

input_size (int): Number of input features per timestep.

hidden_size (int): Size of each liquid layer’s hidden state.

num_layers (int, default=1): Number of stacked liquid layers.

tau (float, default=0.5): Temporal integration factor controlling neuron update speed.

scaling_factor_W/U/alpha (float, default=0.05): Scaling factors for internal neuron parameters.

Features

Multi-layer liquid neural networks for sequential data.

Continuous-time neuron update using tau.

Fully compatible with PyTorch modules.

Users can import only LiquidNeuralNetwork; internal neurons are private.

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

liquidnn-1.0.2.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

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

liquidnn-1.0.2-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file liquidnn-1.0.2.tar.gz.

File metadata

  • Download URL: liquidnn-1.0.2.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for liquidnn-1.0.2.tar.gz
Algorithm Hash digest
SHA256 5999a5165772c113da30dcbadfa050f32f17b86e0517329443da69c1047bc2de
MD5 907c683ab5318f6a84d5c58861d0e8b3
BLAKE2b-256 2188498cb98ed1573585dd3ff9cb5582ce5bcc073ba96fbc977c27dd37dc8acb

See more details on using hashes here.

File details

Details for the file liquidnn-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: liquidnn-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 4.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for liquidnn-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c5e8a1b0cf61dad5ede75085a875401ea98fbb463b8e8edbcf7e5f172ddd90c1
MD5 011a2bc37c6034dd3eab9289981ee43a
BLAKE2b-256 0eee1ba4ce741d8e2ca25102250e454115777b7d5afb89488be50cf792cef1db

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