e3j.linen.SymmetricContraction

class e3j.linen.SymmetricContraction(source_irreps: str, correlation: int, keep_irrep_out: str, num_species: int, num_channels: int, layout: ~e3j.utils.options.Layout | str, l_max: int | None = None, kernel_init: ~jax.nn.initializers.Initializer | ~e3j.utils.options.LinearIndexwiseInitialization | str = 'FAN_IN', rescale_gradients: bool = True, config: ~e3j.utils.config.Config = <factory>, parent: ~flax.linen.module.Module | ~flax.core.scope.Scope | ~flax.linen.module._Sentinel | None = <flax.linen.module._Sentinel object>, name: str | None = None)

Index-wise symmetric contraction B(A, i) = W[i] @ (A + A⊗A + ...).

Note

This module only owns the weights, the computation is done by e3j.core.SymmetricContraction.

Methods

__call__(features, indices)	See e3j.core.SymmetricContraction.__call__().
apply(variables, *args[, rngs, method, ...])	Applies a module method to variables and returns output and modified variables.
bind(variables, *args[, rngs, mutable])	Creates an interactive Module instance by binding variables and RNGs.
clone(*[, parent, _deep_clone, _reset_names])	Creates a clone of this Module, with optionally updated arguments.
copy(*[, parent, name])	Creates a copy of this Module, with optionally updated arguments.
get_variable(col, name[, default])	Retrieves the value of a Variable.
has_rng(name)	Returns true if a PRNGSequence with name name exists.
has_variable(col, name)	Checks if a variable of given collection and name exists in this Module.
init(rngs, *args[, method, mutable, ...])	Initializes a module method with variables and returns modified variables.
init_with_output(rngs, *args[, method, ...])	Initializes a module method with variables and returns output and modified variables.
is_initializing()	Returns True if running under self.init(...) or nn.init(...)().
is_mutable_collection(col)	Returns true if the collection col is mutable.
lazy_init(rngs, *args[, method, mutable])	Initializes a module without providing actual input data.
make_rng([name])	Returns a new RNG key from a given RNG sequence for this Module.
module_paths(rngs, *args[, show_repeated, ...])	Returns a dictionary mapping module paths to module instances.
param(name, init_fn, *init_args[, unbox])	Declares and returns a parameter in this Module.
perturb(name, value[, collection])	Add an zero-value variable ('perturbation') to the intermediate value.
put_variable(col, name, value)	Updates the value of the given variable if it is mutable, or an error otherwise.
setup()	Initializes a Module lazily (similar to a lazy __init__).
sow(col, name, value[, reduce_fn, init_fn])	Stores a value in a collection.
tabulate(rngs, *args[, depth, ...])	Creates a summary of the Module represented as a table.
unbind()	Returns an unbound copy of a Module and its variables.
variable(col, name[, init_fn, unbox])	Declares and returns a variable in this Module.

Attributes

core	Flax-free compute core.
kernel_init
l_max
name
parent
path	Get the path of this Module.
rescale_gradients
scope
target
variables	Returns the variables in this module.
source_irreps
correlation
keep_irrep_out
num_species
num_channels
layout
config

__call__(features: Array, indices: Array) → Array

See e3j.core.SymmetricContraction.__call__().

property core: SymmetricContraction

Flax-free compute core.