netket.models.RBMMultiVal

class netket.models.RBMMultiVal

Bases: Module

A fully connected Restricted Boltzmann Machine (see netket.models.RBM) suitable for large local hilbert spaces. Local quantum numbers are passed through a one hot encoding that maps them onto an enlarged space of +/- 1 spins. In turn, these quantum numbers are used with a standard RBM wave function.

Attributes

alpha: Union[float, int] = 1

feature density. Number of features equal to alpha * input.shape[-1]

path

precision: Any = None

Numerical precision of the computation see jax.lax.Precision for details.

use_hidden_bias: bool = True

if True uses a bias in the dense layer (hidden layer bias).

use_visible_bias: bool = True

if True adds a bias to the input not passed through the nonlinear layer.

variables

Returns the variables in this module.

n_classes: int

The number of classes in the one-hot encoding

Methods

activation()

Logarithm of the hyperbolic cosine, implemented in a more stable way.

has_rng(name)

Returns true if a PRNGSequence with name name exists.

Return type:

bool

Parameters:

name (str) –

is_initializing()

Returns True if running under self.init(…) or nn.init(…)().

This is a helper method to handle the common case of simple initialization where we wish to have setup logic occur when only called under module.init or nn.init. For more complicated multi-phase initialization scenarios it is better to test for the mutability of particular variable collections or for the presence of particular variables that potentially need to be initialized.

Return type:

bool

kernel_init(shape, dtype=<class 'jax.numpy.float64'>)

Return type:

Any

Parameters:

• key (Array) –

• shape (Sequence[Union[int, Any]]) –

• dtype (Any) –

lazy_init(rngs, *args, method=None, mutable=DenyList(deny='intermediates'), **kwargs)

Initializes a module without computing on an actual input.

lazy_init will initialize the variables without doing unnecessary compute. The input data should be passed as a jax.ShapeDtypeStruct which specifies the shape and dtype of the input but no concrete data.

Example:

model = nn.Dense(features=256)
variables = model.lazy_init(
    rng, jax.ShapeDtypeStruct((1, 128), jnp.float32))

The args and kwargs args passed to lazy_init can be a mix of concrete (jax arrays, scalars, bools) and abstract (ShapeDtypeStruct) values. Concrete values are only necessary for arguments that affect the initialization of variables. For example, the model might expect a keyword arg that enables/disables a subpart of the model. In this case, an explicit value (True/Flase) should be passed otherwise lazy_init cannot infer which variables should be initialized.

Parameters:

• rngs (Union[Array, PRNGKeyArray, Dict[str, Union[Array, PRNGKeyArray]]]) – The rngs for the variable collections.

• *args – arguments passed to the init function.

• method (Optional[Callable[..., Any]]) – An optional method. If provided, applies this method. If not provided, applies the __call__ method.

• mutable (Union[bool, str, Collection[str], DenyList]) – Can be bool, str, or list. Specifies which collections should be treated as mutable: bool: all/no collections are mutable. str: The name of a single mutable collection. list: A list of names of mutable collections. By default all collections except “intermediates” are mutable.

• **kwargs – Keyword arguments passed to the init function.

Return type:

FrozenDict[str, Mapping[str, Any]]

Returns:

The initialized variable dict.

perturb(name, value, collection='perturbations')

Add an zero-value variable (‘perturbation’) to the intermediate value.

The gradient of value would be the same as the gradient of this perturbation variable. Therefore, if you define your loss function with both params and perturbations as standalone arguments, you can get the intermediate gradients of value by running jax.grad on the perturbation argument.

Note: this is an experimental API and may be tweaked later for better performance and usability. At its current stage, it creates extra dummy variables that occupies extra memory space. Use it only to debug gradients in training.

Example:

import jax
import jax.numpy as jnp
import flax.linen as nn

class Foo(nn.Module):
    @nn.compact
    def __call__(self, x):
        x = nn.Dense(3)(x)
        x = self.perturb('dense3', x)
        return nn.Dense(2)(x)

def loss(params, perturbations, inputs, targets):
  variables = {'params': params, 'perturbations': perturbations}
  preds = model.apply(variables, inputs)
  return jnp.square(preds - targets).mean()

x = jnp.ones((2, 9))
y = jnp.ones((2, 2))
model = Foo()
variables = model.init(jax.random.PRNGKey(0), x)
intm_grads = jax.grad(loss, argnums=1)(
    variables['params'], variables['perturbations'], x, y)
print(intm_grads['dense3']) # ==> [[-1.456924   -0.44332537  0.02422847]
                            #      [-1.456924   -0.44332537  0.02422847]]

If perturbations are not passed to apply, perturb behaves like a no-op so you can easily disable the behavior when not needed:

model.apply(
    {'params': params, 'perturbations': perturbations},
    x) # works as expected
model.apply({'params': params}, x) # behaves like a no-op

Return type:

TypeVar(T)

Parameters:

• name (str) –

• value (T) –

• collection (str) –

put_variable(col, name, value)

Updates the value of the given variable if it is mutable, or an error otherwise.

Parameters:

• col (str) – the variable collection.

• name (str) – the name of the variable.

• value (Any) – the new value of the variable.

tabulate(rngs, *args, depth=None, show_repeated=False, mutable=True, console_kwargs=None, table_kwargs=mappingproxy({}), column_kwargs=mappingproxy({}), **kwargs)

Creates a summary of the Module represented as a table.

This method has the same signature and internally calls Module.init, but instead of returning the variables, it returns the string summarizing the Module in a table. tabulate uses jax.eval_shape to run the forward computation without consuming any FLOPs or allocating memory.

Additional arguments can be passed into the console_kwargs argument, for example, {‘width’: 120}. For a full list of console_kwargs arguments, see: https://rich.readthedocs.io/en/stable/reference/console.html#rich.console.Console

Example:

import jax
import jax.numpy as jnp
import flax.linen as nn

class Foo(nn.Module):
    @nn.compact
    def __call__(self, x):
        h = nn.Dense(4)(x)
        return nn.Dense(2)(h)

x = jnp.ones((16, 9))

print(Foo().tabulate(jax.random.PRNGKey(0), x))

This gives the following output:

                                Foo Summary
┏━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┓
┃ path    ┃ module ┃ inputs        ┃ outputs       ┃ params              ┃
┡━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━┩
│         │ Foo    │ float32[16,9] │ float32[16,2] │                     │
├─────────┼────────┼───────────────┼───────────────┼─────────────────────┤
│ Dense_0 │ Dense  │ float32[16,9] │ float32[16,4] │ bias: float32[4]    │
│         │        │               │               │ kernel: float32[9,4]│
│         │        │               │               │                     │
│         │        │               │               │ 40 (160 B)          │
├─────────┼────────┼───────────────┼───────────────┼─────────────────────┤
│ Dense_1 │ Dense  │ float32[16,4] │ float32[16,2] │ bias: float32[2]    │
│         │        │               │               │ kernel: float32[4,2]│
│         │        │               │               │                     │
│         │        │               │               │ 10 (40 B)           │
├─────────┼────────┼───────────────┼───────────────┼─────────────────────┤
│         │        │               │         Total │ 50 (200 B)          │
└─────────┴────────┴───────────────┴───────────────┴─────────────────────┘

                      Total Parameters: 50 (200 B)

Note: rows order in the table does not represent execution order, instead it aligns with the order of keys in variables which are sorted alphabetically.

Parameters:

• rngs (Union[Array, PRNGKeyArray, Dict[str, Union[Array, PRNGKeyArray]]]) – The rngs for the variable collections as passed to Module.init.

• *args – The arguments to the forward computation.

• depth (Optional[int]) – controls how many submodule deep the summary can go. By default its None which means no limit. If a submodule is not shown because of the depth limit, its parameter count and bytes will be added to the row of its first shown ancestor such that the sum of all rows always adds up to the total number of parameters of the Module.

• show_repeated (bool) – If True, repeated calls to the same module will be shown in the table, otherwise only the first call will be shown. Default is False.

• mutable (Union[bool, str, Collection[str], DenyList]) – Can be bool, str, or list. Specifies which collections should be treated as mutable: bool: all/no collections are mutable. str: The name of a single mutable collection. list: A list of names of mutable collections. By default all collections except ‘intermediates’ are mutable.

• console_kwargs (Optional[Mapping[str, Any]]) – An optional dictionary with additional keyword arguments that are passed to rich.console.Console when rendering the table. Default arguments are {‘force_terminal’: True, ‘force_jupyter’: False}.

• table_kwargs (Mapping[str, Any]) – An optional dictionary with additional keyword arguments that are passed to rich.table.Table constructor.

• column_kwargs (Mapping[str, Any]) – An optional dictionary with additional keyword arguments that are passed to rich.table.Table.add_column when adding columns to the table.

• **kwargs – keyword arguments to pass to the forward computation.

Return type:

str

Returns:

A string summarizing the Module.

unbind()

Returns an unbound copy of a Module and its variables.

unbind helps create a stateless version of a bound Module.

An example of a common use case: to extract a sub-Module defined inside setup() and its corresponding variables: 1) temporarily bind the parent Module; and then 2) unbind the desired sub-Module. (Recall that setup() is only called when the Module is bound.):

class AutoEncoder(nn.Module):
  def setup(self):
    self.encoder = Encoder()
    self.decoder = Decoder()

  def __call__(self, x):
    return self.decoder(self.encoder(x))

module = AutoEncoder()
variables = module.init(jax.random.PRNGKey(0), jnp.ones((1, 784)))
...
# Extract the Encoder sub-Module and its variables
encoder, encoder_vars = module.bind(variables).encoder.unbind()

Return type:

Tuple[TypeVar(M, bound= Module), Mapping[str, Mapping[str, Any]]]

Returns:

A tuple with an unbound copy of this Module and its variables.

Parameters:

self (M) –

visible_bias_init(shape, dtype=<class 'jax.numpy.float64'>)

Return type:

Any

Parameters:

• key (Array) –

• shape (Sequence[Union[int, Any]]) –

• dtype (Any) –