Skip to main content

An easy-to-use api for the closed-form continuous models in tensorflow

Project description

PyPI 📦   PyTests Downloads

Closed-form Continuous-time Models

Closed-form Continuous-time Neural Networks (CfCs) are powerful sequential neural information processing units.

Paper Open Access: https://www.nature.com/articles/s42256-022-00556-7

Arxiv: https://arxiv.org/abs/2106.13898

Installation

pip install cfc-model

Requirements

  • Python 3.7 or newer
  • Tensorflow 2.4 or newer
  • Pandas
  • Numpy

For a fresh anaconda environment with the required dependencies:

conda env create --file environment.yml
conda activate cfc

Usage

Example

from cfc_model.dense_models import SequentialModel
import numpy as np
X = np.array([[1, 1, 1, 0], [1, 1, 0, 1], [1, 0, 0, 1], [1, 1, 0, 0],
              [1, 0, 1, 0], [1, 1, 0, 1], [1, 0, 0, 1], [1, 0, 1, 0]])
y = np.array([0, 0, 1, 1, 1, 0, 1, 1])
model = SequentialModel()
model.fit(X, y)
y_pred = model.predict([1, 1, 0, 1]) # y_pred equals 0

Configuration

The following configuration states can be used

  • no_gate Runs the CfC without the (1-sigmoid) part
  • minimal Runs the CfC direct solution
  • use_ltc Runs an LTC with a semi-implicit ODE solver instead of a CfC
  • use_mixed Mixes the CfC's RNN-state with a LSTM to avoid vanishing gradients

If none of these flags are provided, the full CfC model is used

Example

# Runs an LTC with a semi-implicit ODE solver instead of a CfC
config = {"use_ltc": True}
model.fit(X, y, config=config)

Cite

@article{hasani_closed-form_2022,
	title = {Closed-form continuous-time neural networks},
	journal = {Nature Machine Intelligence},
	author = {Hasani, Ramin and Lechner, Mathias and Amini, Alexander and Liebenwein, Lucas and Ray, Aaron and Tschaikowski, Max and Teschl, Gerald and 	    Rus, Daniela},
	issn = {2522-5839},
	month = nov,
	year = {2022}

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

cfc_model-1.1.3.tar.gz (23.0 MB view details)

Uploaded Source

Built Distribution

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

cfc_model-1.1.3-py3-none-any.whl (23.0 MB view details)

Uploaded Python 3

File details

Details for the file cfc_model-1.1.3.tar.gz.

File metadata

  • Download URL: cfc_model-1.1.3.tar.gz
  • Upload date:
  • Size: 23.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for cfc_model-1.1.3.tar.gz
Algorithm Hash digest
SHA256 15e06fba3e79937f5c7cff8ab5f09c2028739954b8fb9dae1bc6affca4a37621
MD5 d4f803c998bfebad0c0173954099163d
BLAKE2b-256 1ba0f7bb9620431672ff2b8abca055a91e4cf4130d0607ecb853b6787229d219

See more details on using hashes here.

File details

Details for the file cfc_model-1.1.3-py3-none-any.whl.

File metadata

  • Download URL: cfc_model-1.1.3-py3-none-any.whl
  • Upload date:
  • Size: 23.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for cfc_model-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 aa388bb9726f71443e70fb5e5378b6ea2d8bd4844c2cdd9dc6112af5dbf45f97
MD5 50f514d932f3cb3c7a2d7d159110dedd
BLAKE2b-256 e4f8afa83fc90dc51ffb747bf1b18b79c1bd6ab82d6008f9002fa1ca94f49b36

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