spark.core.tracers#

Classes#

BaseTracer

Base Tracer class

Tracer

Multipurpose exponential tracer.

RDTracer

Rise-Decay Tracer.

RFSTracer

Rise-Fast-Slow Tracer

RUTracer

Resource-Usage tracer for STP (Short Term Plasticity).

Module Contents#

class spark.core.tracers.BaseTracer(shape, seed=None, dtype=jnp.float16, dt=1.0, **kwargs)[source]#

Bases: flax.nnx.Module, abc.ABC

Base Tracer class

Parameters:
  • shape (tuple[int, Ellipsis])

  • seed (int | None)

  • dtype (jax.typing.DTypeLike)

  • dt (float)

shape[source]#
rng[source]#
abstractmethod reset()[source]#
Return type:

None

abstractmethod masked_reset(mask)[source]#
Return type:

None

property value: jax.Array[source]#
Abstractmethod:

Return type:

jax.Array

__call__(x, **kwargs)[source]#
Parameters:

x (jax.Array)

Return type:

jax.Array

class spark.core.tracers.Tracer(shape, tau, scale=1, base=0, **kwargs)[source]#

Bases: BaseTracer

Multipurpose exponential tracer.

Parameters:
scale[source]#
base[source]#
decay[source]#
trace[source]#
reset()[source]#
Return type:

None

masked_reset(mask)[source]#
Return type:

None

property value: jax.Array[source]#
Return type:

jax.Array

class spark.core.tracers.RDTracer(shape, tau_rise, tau_decay, scale_rise=1, scale_decay=1, base_rise=0, base_decay=0, **kwargs)[source]#

Bases: BaseTracer

Rise-Decay Tracer.

Multipurpose double exponential tracer.

Parameters:
tracer_rise[source]#
tracer_decay[source]#
reset()[source]#
Return type:

None

masked_reset(mask)[source]#
Return type:

None

property value: jax.Array[source]#
Return type:

jax.Array

class spark.core.tracers.RFSTracer(shape, alpha, tau_rise, tau_fast_decay, tau_slow_decay, scale_rise=1, scale_fast_decay=1, scale_slow_decay=1, base_rise=0, base_fast_decay=0, base_slow_decay=0, **kwargs)[source]#

Bases: BaseTracer

Rise-Fast-Slow Tracer

Multipurpose triple exponential tracer.

Parameters:
tracer_rise_fast[source]#
tracer_rise_slow[source]#
alpha[source]#
reset()[source]#
Return type:

None

masked_reset(mask)[source]#
Return type:

None

property value: jax.Array[source]#
Return type:

jax.Array

class spark.core.tracers.RUTracer(shape, r_tau, u_tau, u_scale, **kwargs)[source]#

Bases: BaseTracer

Resource-Usage tracer for STP (Short Term Plasticity).

Parameters:
r_tracer[source]#
u_tracer[source]#
reset()[source]#
Return type:

None

masked_reset(mask)[source]#
Return type:

None

property value: jax.Array[source]#
Return type:

jax.Array