rockpool.typehints

Module to provide useful types for Rockpool

See Rockpool Parameter handling for more information on the available types.

Module Attributes

`P_float`	A Parameter or a float
`P_int`	A Parameter or an int
`P_str`	A Parameter or a string
`P_bool`	A Parameter or a boolean
`P_Callable`	A Parameter or a Callable
`P_ndarray`	A Parameter or a numpy array
`Tree`	A Python tree-like object
`Leaf`	A leaf node in a tree
`Value`	The value in a tree leaf node
`Node`	A node in a tree
`P_tree`	A Parameter or a Tree
`P_tensor`	A Parameter or a torch tensor
`FloatVector`	A float scalar or a float vector
`IntVector`	An int scalar or an int vector
`JaxRNGKey`	A Jax RNG key
`JaxTreeDef`	A Jax tree definition
`TreeDef`	A Jax-like tree definition

Exceptions

`DRCError`	An Error class representing a Design-Rule Check violation
`DRCWarning`	A Warning / Error class representing a Design-Rule Check warning