netket_foundation.ParameterSpace

class netket_foundation.ParameterSpace

Bases: AbstractHilbert

Represents the vector space of a single parameter for the model.

Behaves as a standard Hilbert space, but there are no operators defined on it.

Attributes

size

Methods

ptrace(sites)

Returns the hilbert space without the selected sites.

Not all hilbert spaces support this operation.

Parameters:

sites (int | Sequence[int]) – a site or list of sites to trace away

Return type:

Optional[Self]

Returns:

The partially-traced hilbert space. The type of the resulting hilbert space might be different from the starting one.

random_state(key=None, size=None, dtype=None)

Generates either a single or a batch of uniformly distributed random states. Runs as random_state(self, key, size=None, dtype=np.float32) by default.

Parameters:

• key (Any) – rng state from a jax-style functional generator.

• size (int | None) – If provided, returns a batch of configurations of the form (size, N) if size is an integer or (*size, N) if it is a tuple and where \(N\) is the Hilbert space size. By default, a single random configuration with shape (#,) is returned.

• dtype – DType of the resulting vector.

Return type:

Array

Returns:

A state or batch of states sampled from the uniform distribution on the hilbert space.

Example

>>> import netket, jax
>>> hi = netket.hilbert.Qubit(N=2)
>>> k1, k2 = jax.random.split(jax.random.PRNGKey(1))
>>> print(hi.random_state(key=k1))
[0 0]
>>> print(hi.random_state(key=k2, size=2))
[[0 0]
 [0 0]]