Skip to main content
Back to top
Ctrl
+
K
NetKet
Posts
Papers
Get Involved
Citing
Documentation
Search
Ctrl
+
K
Getting started
Installation
First Tutorial
Parallel Computing
Multiple GPUs
Multiple nodes (GPUs)
Multiple CPUs (MPI)
Citing NetKet
User guides
Architecture & Philosophy
Tutorials
Ground-State: Ising model
Ground-State: Bosons in a 3D Harmonic trap
Ground-State: Heisenberg model
Ground-State: J1-J2 model
Vision Transformer wave function
Ground-State: Bosonic Matrix Model
Lattice Fermions, from Slater Determinants to Neural Backflow Transformations
Infidelity Minimization with Stochastic Reconfiguration in NetKet
Symmetries
Equivariant NQS: GCNN for Spin models
Symmetries, Representations and Projectors for arbitrary NQS
Iterative Symmetrization: Coset Filters for Translation Groups
In-depth guides
The Hilbert module
The Operator module
The Sampler module
NetKet Pytrees
The Variational State Interface
Checking Monte Carlo convergence
The Drivers API
Quantum Geometric Tensor and Stochastic Reconfiguration
The Lindblad Master Equation
Representation theory in NetKet
Utilities
Timing and Profiling in NetKet
Time-series data with History and HistoryDict
Extending NetKet
Defining Custom Models
Overriding defaults in NetKet
Defining Custom Preconditioners
Custom operators and observables
Defining custom
expect
and
expect_and_grad
Defining custom local estimators (new)
Custom Hilbert Space Constraints
The Run Loop and Callback Hooks
VMC DIY
Part 1: Hamiltonians and Operators
Part 2: Variational States with Full Summation
Part 3: Monte Carlo Sampling
Developer guides
Contributing to NetKet
Documentation
Writing Tests
Configuration Options
🔪 The Sharp Bits 🔪
API documentation
API Stability
Public API
netket.callbacks
netket.callbacks.AbstractCallback
netket.callbacks.StopRun
netket.callbacks.EarlyStopping
netket.callbacks.ConvergenceStopping
netket.callbacks.InvalidLossStopping
netket.callbacks.Timeout
netket.callbacks.AutoChunkSize
netket.callbacks.AutoSlurmRequeue
netket.drivers
netket.driver.AbstractDriver
netket.driver.AbstractOptimizationDriver
netket.driver.AbstractDynamicsDriver
netket.driver.VMC
netket.driver.VMC_SR
netket.driver.SteadyState
netket.driver.Infidelity_SR
netket.errors
netket.errors.HilbertIndexingDuringTracingError
netket.errors.HolomorphicUndeclaredWarning
netket.errors.InsufficientSamplesForSRWarning
netket.errors.JaxOperatorSetupDuringTracingError
netket.errors.JaxOperatorNotConvertibleToNumba
netket.errors.JaxOperatorGetConnInJitError
netket.errors.NonHolomorphicQGTOnTheFlyDenseRepresentationError
netket.errors.NumbaOperatorGetConnDuringTracingError
netket.errors.OperatorMultiplicationDeprecationWarning
netket.errors.RealQGTComplexDomainError
netket.errors.UnoptimalSRtWarning
netket.errors.SymmModuleInvalidInputShape
netket.errors.ParameterMismatchError
netket.errors.MCMixedStateExpectAndGradOnPhysicalOperatorError
netket.errors.InitializePeriodicLatticeOnSmallLatticeWarning
netket.errors.NNXModuleToSamplerInput
netket.errors.UnoptimisedCustomConstraintRandomStateMethodWarning
netket.errors.UnhashableConstraintError
netket.errors.InvalidConstraintInterface
netket.errors.NetKetPyTreeUndeclaredAttributeAssignmentError
netket.errors.LogAdditionalDataSignatureDeprecationWarning
netket.errors.DriverResetDeprecationWarning
netket.errors.ForwardAndBackwardDeprecationWarning
netket.exact
netket.exact.full_ed
netket.exact.lanczos_ed
netket.exact.steady_state
netket.graph
netket.graph.AbstractGraph
netket.graph.Graph
netket.graph.Lattice
netket.graph.Edgeless
netket.graph.lattice.LatticeSite
netket.graph.Grid
netket.graph.Hypercube
netket.graph.Square
netket.graph.Cube
netket.graph.Chain
netket.graph.Triangular
netket.graph.Honeycomb
netket.graph.KitaevHoneycomb
netket.graph.Kagome
netket.graph.BCC
netket.graph.FCC
netket.graph.Diamond
netket.graph.Pyrochlore
netket.graph.space_group.SpaceGroup
netket.graph.space_group.TranslationGroup
netket.graph.DoubledGraph
netket.graph.disjoint_union
netket.hilbert
netket.hilbert.TensorHilbert
netket.hilbert.DoubledHilbert
netket.hilbert.Spin
netket.hilbert.Qubit
netket.hilbert.Fock
netket.hilbert.SpinOrbitalFermions
netket.hilbert.AbstractHilbert
netket.hilbert.DiscreteHilbert
netket.hilbert.HomogeneousHilbert
netket.experimental.hilbert.ContinuousHilbert
netket.experimental.hilbert.Particle
netket.hilbert.constraint.DiscreteHilbertConstraint
netket.hilbert.constraint.SumConstraint
netket.hilbert.constraint.SumOnPartitionConstraint
netket.hilbert.constraint.ExtraConstraint
netket.hilbert.random.flip_state
netket.hilbert.random.random_state
netket.hilbert.index.optimalConstrainedHilbertindex
netket.jax
netket.jax.HashablePartial
netket.jax.PRNGKey
netket.jax.PRNGSeq
netket.jax.tree_dot
netket.jax.tree_norm
netket.jax.tree_ax
netket.jax.tree_axpy
netket.jax.tree_cast
netket.jax.tree_conj
netket.jax.tree_size
netket.jax.tree_leaf_iscomplex
netket.jax.tree_ishomogeneous
netket.jax.tree_to_real
netket.jax.dtype_complex
netket.jax.is_complex_dtype
netket.jax.maybe_promote_to_complex
netket.jax.expect
netket.jax.vjp
netket.jax.jacobian
netket.jax.jacobian_default_mode
netket.jax.chunk
netket.jax.unchunk
netket.jax.apply_chunked
netket.jax.vmap_chunked
netket.jax.vjp_chunked
netket.jax.logsumexp_cplx
netket.jax.logdet_cmplx
netket.logging
netket.logging.AbstractLog
netket.logging.RuntimeLog
netket.logging.JsonLog
netket.logging.StateLog
netket.logging.TensorBoardLog
netket.logging.HDF5Log
netket.logging.MLFlowLog
netket.logging.SaveVariationalState
netket.models
netket.models.LogStateVector
netket.models.RBM
netket.models.RBMModPhase
netket.models.RBMMultiVal
netket.models.RBMSymm
netket.models.Jastrow
netket.models.NDM
netket.models.GCNN
netket.models.DeepSetMLP
netket.models.MLP
netket.models.AbstractARNN
netket.models.ARNNSequential
netket.models.FastARNNSequential
netket.models.ARNNDense
netket.models.ARNNConv1D
netket.models.ARNNConv2D
netket.models.FastARNNConv1D
netket.models.FastARNNConv2D
netket.models.Gaussian
netket.models.DeepSetRelDistance
netket.models.tensor_networks.MPSOpen
netket.models.tensor_networks.MPSPeriodic
netket.models.tensor_networks.MPDOOpen
netket.models.tensor_networks.MPDOPeriodic
netket.models.Slater2nd
netket.models.MultiSlater2nd
netket.experimental.models.RNN
netket.experimental.models.FastRNN
netket.experimental.models.LSTMNet
netket.experimental.models.FastLSTMNet
netket.experimental.models.GRUNet1D
netket.experimental.models.FastGRUNet1D
netket.nn
netket.nn.DenseSymm
netket.nn.DenseEquivariant
netket.nn.MaskedDense1D
netket.nn.MaskedConv1D
netket.nn.MaskedConv2D
netket.nn.FastMaskedDense1D
netket.nn.FastMaskedConv1D
netket.nn.FastMaskedConv2D
netket.nn.activation.reim
netket.nn.activation.reim_relu
netket.nn.activation.reim_selu
netket.nn.activation.log_cosh
netket.nn.activation.log_sinh
netket.nn.activation.log_tanh
netket.nn.binary_encoding
netket.nn.to_array
netket.nn.to_matrix
netket.nn.apply_operator.ApplyOperatorModuleLinen
netket.nn.apply_operator.ApplyOperatorModuleNNX
netket.nn.apply_operator.make_logpsi_op_afun
netket.nn.freeze_parameters
netket.nn.unfreeze_parameters
netket.nn.blocks.MLP
netket.nn.blocks.DeepSetMLP
netket.nn.blocks.SymmExpSum
netket.experimental.nn.rnn.RNNLayer
netket.experimental.nn.rnn.FastRNNLayer
netket.experimental.nn.rnn.RNNCell
netket.experimental.nn.rnn.LSTMCell
netket.experimental.nn.rnn.GRU1DCell
netket.experimental.nn.rnn.check_reorder_idx
netket.experimental.nn.rnn.ensure_prev_neighbors
netket.experimental.nn.rnn.get_snake_inv_reorder_idx
netket.observable
netket.observable.AbstractObservable
netket.observable.Renyi2EntanglementEntropy
netket.observable.VarianceObservable
netket.observable.InfidelityOperator
netket.observable.VScore
netket.operator
netket.operator.AbstractOperator
netket.operator.AbstractSuperOperator
netket.operator.DiscreteOperator
netket.operator.DiscreteJaxOperator
netket.operator.ContinuousOperator
netket.operator.BoseHubbardJax
netket.operator.BoseHubbardNumba
netket.operator.GraphOperator
netket.operator.LocalOperatorJax
netket.operator.LocalOperatorNumba
netket.operator.IsingJax
netket.operator.IsingNumba
netket.operator.Heisenberg
netket.operator.PauliStringsJax
netket.operator.PauliStringsNumba
netket.operator.LocalLiouvillian
netket.operator.FermionOperator2ndJax
netket.operator.FermionOperator2ndNumba
netket.operator.FermiHubbardJax
netket.experimental.operator.ParticleNumberConservingFermioperator2nd
netket.experimental.operator.ParticleNumberAndSpinConservingFermioperator2nd
netket.operator.KineticEnergy
netket.operator.PotentialEnergy
netket.operator.permutation.PermutationOperator
netket.operator.permutation.PermutationOperatorFermion
netket.operator.permutation.construct_permutation_operator
netket._src.operator.spin_flip.SpinFlipOperator
netket.operator.SumOperator
netket.operator.ProductOperator
netket.operator.EmbedOperator
netket.operator.boson.create
netket.operator.boson.destroy
netket.operator.boson.identity
netket.operator.boson.number
netket.operator.boson.proj
netket.operator.spin.identity
netket.operator.spin.sigmax
netket.operator.spin.sigmay
netket.operator.spin.sigmaz
netket.operator.spin.sigmap
netket.operator.spin.sigmam
netket.operator.fermion.create
netket.operator.fermion.destroy
netket.operator.fermion.number
netket.operator.to_sparse_cached
netket.operator._local_operator.LocalOperator
netket.operator._local_operator.LocalOperatorBase
netket.operator._ising.Ising
netket.operator._ising.IsingBase
netket.operator._pauli_strings.PauliStrings
netket.operator._pauli_strings.PauliStringsBase
netket.operator._fermion2nd.FermionOperator2nd
netket.operator._fermion2nd.FermionOperator2ndBase
netket.operator._sum.SumContinuousOperator
netket.operator._sum.SumGenericOperator
netket.operator._sum.SumDiscreteJaxOperator
netket.operator._sum.SumDiscreteOperator
netket.operator._prod.ProductGenericOperator
netket.operator._prod.ProductDiscreteOperator
netket.operator._prod.ProductDiscreteJaxOperator
netket.optimizer
netket.optimizer.Adam
netket.optimizer.AdaGrad
netket.optimizer.Sgd
netket.optimizer.Momentum
netket.optimizer.RmsProp
netket.optimizer.SR
netket.optimizer.qgt.QGTAuto
netket.optimizer.qgt.QGTOnTheFly
netket.optimizer.qgt.QGTJacobianPyTree
netket.optimizer.qgt.QGTJacobianDense
netket.optimizer.solver.cholesky_with_fallback
netket.optimizer.solver.cholesky
netket.optimizer.solver.LU
netket.optimizer.solver.pinv
netket.optimizer.solver.pinv_smooth
netket.optimizer.solver.solve
netket.optimizer.solver.svd
netket.optimizer.solver.nan_fallback
netket.optimizer.solver.cholesky_distributed
netket.optimizer.solver.pinv_smooth_distributed
netket.sampler
netket.sampler.Sampler
netket.sampler.SamplerState
netket.sampler.MetropolisSamplerState
netket.sampler.ExactSampler
netket.sampler.MetropolisSampler
netket.sampler.MetropolisSamplerNumpy
netket.sampler.ParallelTemperingSampler
netket.sampler.ARDirectSampler
netket.sampler.MetropolisLocal
netket.sampler.MetropolisExchange
netket.sampler.MetropolisHamiltonian
netket.sampler.MetropolisGaussian
netket.sampler.MetropolisAdjustedLangevin
netket.sampler.ParallelTemperingLocal
netket.sampler.ParallelTemperingExchange
netket.sampler.ParallelTemperingHamiltonian
netket.sampler.MetropolisFermionHop
netket.sampler.rules.MetropolisRule
netket.sampler.rules.LocalRule
netket.sampler.rules.GlobalSpinFlipRule
netket.sampler.rules.CustomRuleNumpy
netket.sampler.rules.ExchangeRule
netket.sampler.rules.FixedRule
netket.sampler.rules.HamiltonianRule
netket.sampler.rules.HamiltonianRuleNumpy
netket.sampler.rules.GaussianRule
netket.sampler.rules.LangevinRule
netket.sampler.rules.FermionHopRule
netket.sampler.rules.TensorRule
netket.sampler.rules.MultipleRules
netket.sampler.SamplerState
netket.sampler.MetropolisSamplerState
netket.sampler.MetropolisFermionHop
netket.sampler.rules.FermionHopRule
netket.symmetry
netket.symmetry.spin_flip_representation
netket.symmetry.canonical_representation
netket.symmetry.Representation
netket.symmetry.LabeledRepresentation
netket.symmetry.TranslationRepresentation
netket.symmetry.group.FiniteGroup
netket.symmetry.group.Permutation
netket.symmetry.group.PermutationGroup
netket.symmetry.group.cyclic_group
netket.symmetry.group.PGSymmetry
netket.symmetry.group.PointGroup
netket.symmetry.group.axial
netket.symmetry.group.planar
netket.symmetry.group.cubic
netket.symmetry.group.icosa
netket._src.symmetry.labeled_representation_coset_filter.LabeledRepresentationCosetFilter
netket._src.symmetry.translation_coset_filter.TranslationCosetFilter
netket.stats
netket.stats.statistics
netket.stats.Stats
netket.stats.StatsBatch
netket.stats.online_statistics
netket.stats.OnlineStats
netket.stats.online_statistics_batch
netket.stats.OnlineStatsBatch
netket.stats.LocalEstimators
netket.stats.LocalEstimatorsBatch
netket.utils
netket.utils.is_probably_holomorphic
netket.utils.struct.Pytree
netket.utils.struct.field
netket.utils.struct.ShardedFieldSpec
netket.utils.HashableArray
netket.utils.StaticRange
netket.utils.numbers.StaticZero
netket.utils.walk_tree_with_path
netket.utils.history.History
netket.utils.history.HistoryDict
netket.utils.history.accum_histories_in_tree
netket.utils.timing.Timer
netket.utils.timing.timed_scope
netket.utils.timing.timed
netket.vqs
netket.vqs.VariationalState
netket.vqs.VariationalMixedState
netket.vqs.FullSumState
netket.vqs.MCState
netket.vqs.MCMixedState
netket.experimental.vqs.DeterminantVariationalState
netket.vqs.apply_operator
netket.vqs.local_estimators
netket.vqs.get_local_kernel
netket.vqs.get_local_kernel_arguments
netket.vqs.freeze_parameters
netket.vqs.unfreeze_parameters
netket.driver.VMC
netket.driver.SteadyState
Experimental API
netket.experimental.QSR
netket.experimental.operator.ParticleNumberConservingFermioperator2nd
netket.experimental.operator.ParticleNumberAndSpinConservingFermioperator2nd
netket.experimental.operator.from_pyscf_molecule
netket.experimental.operator.pyscf.TV_from_pyscf_molecule
netket.experimental.geometry.Cell
netket.experimental.geometry.FreeSpace
netket.experimental.vqs.variables_from_file
netket.experimental.vqs.variables_from_tar
netket.experimental.TDVP
netket.experimental.driver.TDVPSchmitt
netket.experimental.dynamics.Euler
netket.experimental.dynamics.Heun
netket.experimental.dynamics.Midpoint
netket.experimental.dynamics.RK12
netket.experimental.dynamics.RK23
netket.experimental.dynamics.RK4
netket.experimental.dynamics.RK45
netket.experimental.dynamics.AbstractSolver
netket.experimental.dynamics.AbstractSolverState
Change Log
Developer guides
Repository
Open issue
.md
.pdf
Developer guides
Developer guides
#
Developer guides
Contributing to NetKet
Documentation
Writing Tests
