Skip to main content
Ctrl+K
NetKet
  • Posts
  • Get Involved
  • Citing
  • Documentation
  • API Reference
  • Get Started
Logo image

Getting Started

  • Installation

Tutorials

  • Ground-State: Ising model
  • Ground-State: Bosons in a 3D Harmonic trap
  • Ground-State: Heisenberg model
  • Ground-State: J1-J2 model
  • Ground-State: Bosonic Matrix Model
  • Symmetries: Honeycomb Heisenberg model
  • Lattice Fermions, from Slater Determinants to Neural Backflow Transformations

Reference Documentation

  • 🔪 The Sharp Bits 🔪
  • The Hilbert module
  • The Operator module
  • The Sampler module
  • The Variational State Interface
  • Quantum Geometric Tensor and Stochastic Reconfiguration
  • The Drivers API
  • The Lindblad Master Equation

Extending NetKet

  • Defining Custom Models
  • Overriding defaults in NetKet
  • Defining Custom Preconditioners
  • Defining Custom Operators

API documentation

  • API Stability
  • Change Log
  • Configuration Options
  • Public API
    • netket.callbacks
      • netket.callbacks.EarlyStopping
      • netket.callbacks.ConvergenceStopping
      • netket.callbacks.InvalidLossStopping
      • netket.callbacks.Timeout
    • netket.drivers
      • netket.driver.AbstractVariationalDriver
      • netket.driver.VMC
      • netket.driver.SteadyState
    • netket.errors
      • netket.errors.HilbertIndexingDuringTracingError
      • netket.errors.HolomorphicUndeclaredWarning
      • netket.errors.JaxOperatorSetupDuringTracingError
      • netket.errors.NonHolomorphicQGTOnTheFlyDenseRepresentationError
      • netket.errors.NumbaOperatorGetConnDuringTracingError
      • netket.errors.RealQGTComplexDomainError
    • 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.Hypercube
      • netket.graph.lattice.LatticeSite
      • netket.graph.Grid
      • netket.graph.Diamond
      • netket.graph.Kagome
      • netket.graph.Square
      • netket.graph.Chain
      • netket.graph.Cube
      • netket.graph.BCC
      • netket.graph.FCC
      • netket.graph.Honeycomb
      • netket.graph.KitaevHoneycomb
      • netket.graph.Triangular
      • netket.graph.Pyrochlore
      • netket.graph.DoubledGraph
      • netket.graph.disjoint_union
    • netket.hilbert
      • netket.hilbert.CustomHilbert
      • netket.hilbert.TensorHilbert
      • netket.hilbert.DoubledHilbert
      • netket.hilbert.Spin
      • netket.hilbert.Qubit
      • netket.hilbert.Fock
      • netket.hilbert.Particle
      • netket.experimental.hilbert.SpinOrbitalFermions
      • netket.hilbert.AbstractHilbert
      • netket.hilbert.ContinuousHilbert
      • netket.hilbert.DiscreteHilbert
      • netket.hilbert.HomogeneousHilbert
      • netket.hilbert.random.flip_state
      • netket.hilbert.random.random_state
    • netket.jax
      • netket.jax.HashablePartial
      • netket.jax.PRNGKey
      • netket.jax.PRNGSeq
      • netket.jax.mpi_split
      • netket.jax.tree_dot
      • 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_ravel
      • 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.logging
      • netket.logging.RuntimeLog
      • netket.logging.JsonLog
      • netket.logging.StateLog
      • netket.logging.TensorBoardLog
    • netket.models
      • netket.models.LogStateVector
      • netket.models.RBM
      • netket.models.RBMModPhase
      • netket.models.RBMMultiVal
      • netket.models.RBMSymm
      • netket.models.Jastrow
      • netket.models.MPSPeriodic
      • netket.models.NDM
      • netket.models.GCNN
      • netket.models.AbstractARNN
      • netket.models.ARNNDense
      • netket.models.ARNNConv1D
      • netket.models.ARNNConv2D
      • netket.models.FastARNNConv1D
      • netket.models.FastARNNConv2D
      • netket.models.DeepSetMLP
      • netket.models.MLP
      • netket.models.Gaussian
      • netket.models.DeepSetRelDistance
    • 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.states_to_numbers
      • netket.nn.to_array
      • netket.nn.to_matrix
      • netket.nn.blocks.MLP
      • netket.nn.blocks.DeepSetMLP
      • netket.nn.blocks.SymmExpSum
    • netket.operator
      • netket.operator.AbstractOperator
      • netket.operator.AbstractSuperOperator
      • netket.operator.DiscreteOperator
      • netket.operator.DiscreteJaxOperator
      • netket.operator.ContinuousOperator
      • netket.operator.BoseHubbard
      • netket.operator.GraphOperator
      • netket.operator.LocalOperator
      • netket.operator.Ising
      • netket.operator.IsingJax
      • netket.operator.Heisenberg
      • netket.operator.PauliStrings
      • netket.operator.PauliStringsJax
      • netket.operator.LocalLiouvillian
      • netket.experimental.operator.FermionOperator2nd
      • netket.operator.KineticEnergy
      • netket.operator.PotentialEnergy
      • netket.operator.SumOperator
      • netket.operator.boson.create
      • netket.operator.boson.destroy
      • netket.operator.boson.number
      • netket.operator.boson.proj
      • netket.operator.spin.sigmax
      • netket.operator.spin.sigmay
      • netket.operator.spin.sigmaz
      • netket.operator.spin.sigmap
      • netket.operator.spin.sigmam
      • netket.experimental.operator.fermion.create
      • netket.experimental.operator.fermion.destroy
      • netket.experimental.operator.fermion.number
    • 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
      • netket.optimizer.solver.LU
      • netket.optimizer.solver.pinv
      • netket.optimizer.solver.pinv_smooth
      • netket.optimizer.solver.solve
      • netket.optimizer.solver.svd
    • netket.sampler
      • netket.sampler.Sampler
      • netket.sampler.SamplerState
      • netket.sampler.MetropolisSamplerState
      • netket.sampler.MetropolisRule
      • netket.sampler.ExactSampler
      • netket.sampler.MetropolisSampler
      • netket.sampler.MetropolisSamplerNumpy
      • netket.sampler.ARDirectSampler
      • netket.experimental.sampler.MetropolisPtSampler
      • netket.sampler.MetropolisLocal
      • netket.sampler.MetropolisExchange
      • netket.sampler.MetropolisHamiltonian
      • netket.sampler.MetropolisGaussian
      • netket.sampler.MetropolisAdjustedLangevin
      • netket.experimental.sampler.MetropolisLocalPt
      • netket.experimental.sampler.MetropolisExchangePt
      • netket.sampler.rules.MetropolisRule
      • netket.sampler.rules.LocalRule
      • 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.TensorRule
      • netket.sampler.rules.MultipleRules
      • netket.sampler.SamplerState
      • netket.sampler.MetropolisSamplerState
    • netket.stats
      • netket.stats.statistics
    • netket.utils
      • netket.utils.is_probably_holomorphic
      • netket.utils.HashableArray
      • netket.utils.mpi.available
      • netket.utils.mpi.n_nodes
      • netket.utils.mpi.rank
      • netket.utils.mpi.MPI_jax_comm
      • netket.utils.mpi.MPI_py_comm
      • netket.utils.group.Permutation
      • netket.utils.group.PermutationGroup
      • netket.utils.group.FiniteGroup
      • netket.utils.group.PointGroup
    • netket.vqs
      • netket.vqs.VariationalState
      • netket.vqs.VariationalMixedState
      • netket.vqs.FullSumState
      • netket.vqs.MCState
      • netket.vqs.MCMixedState
      • netket.vqs.get_local_kernel
      • netket.vqs.get_local_kernel_arguments
    • netket.driver.VMC
    • netket.driver.SteadyState
  • Experimental API
    • netket.experimental.QSR
    • netket.experimental.sampler.MetropolisPtSampler
    • netket.experimental.sampler.MetropolisLocalPt
    • netket.experimental.sampler.MetropolisExchangePt
    • netket.experimental.sampler.MetropolisSamplerPmap
    • netket.experimental.logging.HDF5Log
    • 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.hilbert.SpinOrbitalFermions
    • netket.experimental.operator.FermionOperator2nd
    • netket.experimental.operator.fermion.create
    • netket.experimental.operator.fermion.destroy
    • netket.experimental.operator.fermion.number
    • netket.experimental.observable.Renyi2EntanglementEntropy

Developer Documentation

  • Contributing to NetKet
  • Writing Tests
  • Repository
  • Open issue
  • .md

Public API

Contents

  • Subpackages
  • Default drivers

Public API#

This page lists the documentation of all sub-packages of NetKet.

Subpackages#

  • netket.callbacks
  • netket.drivers
  • netket.errors
  • netket.exact
  • netket.graph
  • netket.hilbert
  • netket.jax
  • netket.logging
  • netket.models
  • netket.nn
  • netket.operator
  • netket.optimizer
  • netket.sampler
  • netket.stats
  • netket.utils
  • netket.vqs

Default drivers#

VMC

Energy minimization using Variational Monte Carlo (VMC).

SteadyState

Steady-state driver minimizing L^†L.

previous

Configuration Options

next

netket.callbacks

Contents
  • Subpackages
  • Default drivers

© Copyright 2019-2021, The Netket authors - All rights reserved.