API Reference

Full reference documentation for all public classes and functions in netket_foundation.

Hilbert space

netket_foundation.ParameterSpace

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

Variational state

netket_foundation.FoundationalQuantumState

Variational state that jointly samples physical configurations and fixed parameter replicas.

Observables

netket_foundation.observable.SusceptibilityObservable

Observable for the fidelity susceptibility matrix.

Saving and loading

Save a variational state bundled with its importance-sampling reference (sampled configurations and reference log-probabilities), so that loading is instantaneous and the IS reference is exactly reproducible.

netket_foundation.vqs.save	Save state together with its reference samples and log-probabilities.
netket_foundation.vqs.load	Load an archive written by save().
netket_foundation.vqs.samples_with_probability	Return the reference SamplesWithProb of state.

Importance sampling

Estimate expectation values of a target state from samples drawn from a reference distribution, together with the corresponding result and diagnostics types.

netket_foundation.expectation_value.ISState	Importance-sampled view: physical samples drawn from a reference distribution (characterized by log_probs_ref) evaluated at variables under apply_fn.
netket_foundation.expectation_value.SamplesWithProb	A bundle of sampled configurations and their reference log-probabilities.
netket_foundation.expectation_value.ISResult	netket.stats.Stats extended with importance-sampling diagnostics (ess, ess_fraction, n_samples).
netket_foundation.expectation_value.ISMatrixResult	netket.stats.StatsBatch extended with importance-sampling diagnostics (ess, ess_fraction, n_samples).

Driver

netket_foundation.VMC_SR

Energy minimization using Variational Monte Carlo (VMC) and Stochastic Reconfiguration (SR) / Natural Gradient Descent, specialized for the foundational training scheme.

Operators

See the Operators page for full documentation of all operator classes and factory functions.