Welcome to ngc-learn’s documentation!

ngc-learn is a Python library for building, simulating, and analyzing biomimetic and NeuroAI computational models, arbitrary predictive processing/coding models, spiking neural networks, and general dynamical systems. This toolkit is built on top of JAX and is distributed under the 3-Clause BSD license.

Introduction:

• Overview
• Installation

Tutorials

• Introduction
• Theory and Design Motivation
• Configuration Basics
• Modeling Basics
• Neurocognitive Modeling Lessons

Model Museum

• The Model Museum
• Model Exhibits

Modeling API

• The Nodes-and-Cables System
• Neuronal Cells
• Synapses
• Input Encoders
• Other Operators

Source API

• ngclearn
  • ngclearn package
    • Subpackages
      • ngclearn.components package
        • Subpackages
          • ngclearn.components.input_encoders package
          • ngclearn.components.neurons package
          • ngclearn.components.other package
          • ngclearn.components.synapses package
        • Submodules
        • ngclearn.components.jaxComponent module
          • JaxComponent
        • Module contents
      • ngclearn.modules package
        • Subpackages
          • ngclearn.modules.regression package
        • Module contents
      • ngclearn.operations package
        • Module contents
      • ngclearn.utils package
        • Subpackages
          • ngclearn.utils.analysis package
          • ngclearn.utils.density package
          • ngclearn.utils.diffeq package
          • ngclearn.utils.feature_dictionaries package
          • ngclearn.utils.masks package
          • ngclearn.utils.optim package
          • ngclearn.utils.viz package
        • Submodules
        • ngclearn.utils.JaxProcessesMixin module
          • JaxJointProcess
          • JaxMethodProcess
          • JaxProcessesMixin
        • ngclearn.utils.data_loader module
          • DataLoader
        • ngclearn.utils.distribution_generator module
          • DistributionGenerator
          • DistributionInitializer
          • DistributionParams
        • ngclearn.utils.io_utils module
          • deserialize()
          • load_pkl()
          • makedir()
          • makedirs()
          • save_pkl()
          • serialize()
        • ngclearn.utils.metric_utils module
          • analyze_scores()
          • measure_ACC()
          • measure_BCE()
          • measure_BIC()
          • measure_CatNLL()
          • measure_KLD()
          • measure_MAE()
          • measure_MSE()
          • measure_RMSE()
          • measure_breadth_TC()
          • measure_fanoFactor()
          • measure_firingRate()
          • measure_gaussian_KLD()
          • measure_sparsity()
        • ngclearn.utils.model_utils module
          • binarize()
          • bkwta()
          • clamp_max()
          • clamp_min()
          • clip()
          • create_function()
          • d_clip()
          • d_elu()
          • d_gelu()
          • d_heaviside()
          • d_identity()
          • d_lrelu()
          • d_relu()
          • d_relu6()
          • d_sigmoid()
          • d_silu()
          • d_sine()
          • d_softplus()
          • d_swish()
          • d_tanh()
          • d_telu()
          • d_threshold()
          • drop_out()
          • elu()
          • gelu()
          • heaviside()
          • identity()
          • inverse_logistic()
          • inverse_sigmoid()
          • inverse_tanh()
          • layer_normalize()
          • lrelu()
          • normalize_matrix()
          • one_hot()
          • pull_equations()
          • relu()
          • relu6()
          • sigmoid()
          • silu()
          • sine()
          • softmax()
          • softplus()
          • swish()
          • tanh()
          • telu()
          • tensorstats()
          • threshold()
          • threshold_cauchy()
          • threshold_soft()
        • ngclearn.utils.patch module
          • PatchGenerator
        • ngclearn.utils.patch_utils module
          • Create_Patches
          • generate_pacthify_patch_set()
          • generate_patch_set()
          • patch_with_overlap()
          • patch_with_stride()
        • ngclearn.utils.surrogate_fx module
          • arctan_estimator()
          • secant_lif_estimator()
          • straight_through_estimator()
          • triangular_estimator()
        • Module contents
    • Module contents

NGC-Learn Papers & Media

• List of Papers and Publications
• Talks and Media Related to NGC-Learn

Indices and tables

• Index

• Module Index

• Search Page