BrainX Ecosystem

Home

Platform

Full-Scale Simulation AI Compatibility Differentiable Optimization Powered by JAX

Ecosystem

Research

Papers about BrainX Papers using BrainX Papers citing BrainX

Community

Documentation

Packages

brainunit brainstate brainpy.state braincell brainmass brainevent braintrace braintools

Legacy

brainpy ↗

Skip to main content

Ctrl+K

Getting Started

Installation
Quickstart
Thinking in BrainState

Tutorials

Core
Transformations
Brain Dynamics

How-to Guides

Save and Load Checkpoints
Graph and Node System
Utility Toolkit
Collective Operations
Mixin System
Observe and Intercept State Access with Hooks
Constrain and Regularize Parameters
Interoperate with Flax and Equinox
Migrating Concepts from PyTorch to BrainState

Concepts

Why State-Based?
The State Model
The Parameter Model
The Graph Model
Transformation Semantics
Time and Environment
The Typing System

Examples

Deep Learning
Brain Dynamics

API Reference

Release Notes
brainstate module
brainstate.graph moduel
brainstate.nn module
brainstate.transform module
brainstate.interop module
brainstate.random module
- RandomState
- brainstate.random.DEFAULT
- seed
- seed_context
- default_rng
- clone_rng
- set_key
- get_key
- get_key_data
- restore_key
- split_key
- split_keys
- self_assign_multi_keys
- rand
- randn
- random
- random_sample
- ranf
- sample
- randint
- random_integers
- rand_like
- randint_like
- randn_like
- choice
- permutation
- shuffle
- beta
- exponential
- gamma
- gumbel
- laplace
- logistic
- normal
- pareto
- standard_cauchy
- standard_exponential
- standard_gamma
- standard_normal
- standard_t
- uniform
- truncated_normal
- lognormal
- power
- rayleigh
- triangular
- vonmises
- wald
- weibull
- weibull_min
- maxwell
- t
- loggamma
- bernoulli
- binomial
- categorical
- geometric
- hypergeometric
- logseries
- multinomial
- negative_binomial
- poisson
- zipf
- chisquare
- dirichlet
- f
- multivariate_normal
- noncentral_chisquare
- noncentral_f
- orthogonal
brainstate.util module
brainstate.typing module
- Array
- ArrayLike
- Shape
- Size
- Axes
- DType
- DTypeLike
- SupportsDType
- PyTree
- Key
- PathParts
- Predicate
- Filter
- FilterLiteral
- SeedOrKey
- K
- _T
- _Annotation
- Missing
brainstate.mixin module
brainstate.environ module
- reset
- context
- get
- set
- pop
- all
- EnvironmentState
- get_platform
- set_platform
- get_host_device_count
- set_host_device_count
- get_precision
- set_precision
- dftype
- ditype
- dutype
- dctype
- tolerance
- get_dt
- I
- T
- DT
- PRECISION
- PLATFORM
- HOST_DEVICE_COUNT
- JIT_ERROR_CHECK
- FIT
- DEFAULT_PRECISION
- SUPPORTED_PLATFORMS
- SUPPORTED_PRECISIONS
- register_default_behavior
- unregister_default_behavior
- list_registered_behaviors

.rst

HookCancellationError

Contents

HookCancellationError

HookCancellationError#

class brainstate.HookCancellationError[source]#: Exception raised when a hook cancels an operation.

previous

HookRegistrationError

next

HookWarning

Contents

HookCancellationError

By BrainState Developers

© Copyright 2024, brainstate.

Last updated on Jun 01, 2026.

BrainX Ecosystem

An open, differentiable ecosystem for brain simulation. We build the foundations the next decade of computational neuroscience will run on.

Platform

Full-Scale Simulation
AI Compatibility
Differentiable Optimization
Powered by JAX

Documentation

brainunit
brainstate
braincell
brainevent
All 9 packages →

Research

Papers about BrainX
Papers using BrainX
Papers citing BrainX
How to cite →

Community

Contributors
Discussions
Issue tracker
Get involved

© 2026 BrainX Developers · How to cite →

Apache-2.0 JAX