NetKet
  • Get Started
  • Documentation
  • Tutorials
  • Citing NetKet
  • About
  • Site
    Netket 3.0 Documentation

    Reference Documentation

    • Getting Started
      • Installation and requirements
        • MPI
        • Apple M1 (ARM)
      • Introduction
      • Jax/Flax extensions
      • Legacy API support (API before 2021)
      • Commented Example
    • Change Log
      • NetKet 3.4 (⚙️ In development)
        • New features
        • Breaking Changes
        • Internal Changes
        • Bug Fixes
      • NetKet 3.3.2 (🐛 Bug Fixes)
        • Internal Changes
        • Bug Fixes
      • NetKet 3.3.1 (🐛 Bug Fixes)
      • NetKet 3.3 (🎁 20 December 2021)
        • New features
        • Breaking Changes
        • Deprecations
        • Internal Changes
        • Bug Fixes
      • NetKet 3.2 (26 November 2021)
        • New features
        • Breaking Changes
        • Bug Fixes
      • NetKet 3.1 (20 October 2021)
        • New features
        • Breaking Changes
        • Internal Changes
        • Bug Fixes
      • NetKet 3.0 (23 august 2021)
        • New features
        • Breaking Changes
        • Internal Changes
        • Bug Fixes
      • NetKet 3.0b4 (17 august 2021)
        • New features
        • Breaking Changes
        • Internal Changes
        • Bug Fixes
      • NetKet 3.0b3 (published on 9 july 2021)
        • New features
        • Breaking Changes
        • Internal Changes
        • Bug Fixes
      • NetKet 3.0b2 (published on 31 May 2021)
        • New features
        • Breaking Changes
        • Bug Fixes
      • NetKet 3.0b1 (published beta release)
        • API Changes
    • The Lindblad Master Equation
      • The Density Matrix and the Liouvillian
      • Computing Observables
    • The Hilbert module
      • The AbstractHilbert interface
        • Attributes
        • Composing Hilbert spaces
      • The DiscreteHilbert interface
        • Indexable spaces
        • Constrained Hilbert spaces
        • Defining Custom constraints
      • Using Hilbert spaces with jax.jitted functions
    • The Operator module
      • The DiscreteOperator interface
    • The Variational State Interface
      • Constructing a Variational State
        • Defining models: Flax
        • MCState
      • Using a Monte Carlo Variational State
        • Expectation values
        • Sampling
        • Collecting the state-vector
        • Manipulating the parameters
      • Saving and Loading a Variational State
      • Using ExactState for testing
    • Quantum Geometric Tensor and Stochastic Reconfiguration
      • Stochastic Reconfiguration
        • Using stochastic reconfiguration
    • The Drivers API
      • Constructing a driver
      • Running the optimisation
    • 🔪 The Sharp Bits 🔪
      • Parallelization
      • Running on CPU when GPUs are present
      • Using GPUs
      • NaNs in training and loss of precision

    Extending NetKet

    • Defining Custom Models
      • Commonalities
        • Defining models: init and apply functions
      • Using Flax Linen
      • Using Jax/Stax
      • Using Haiku
    • Overriding defaults in NetKet
      • NetKet Architecture: Multiple Dispatch
    • Defining Custom Preconditioners
      • The preconditioner interface
        • The LinearPreconditioner interface
          • Bare interface
          • LinearOperator interface
        • The preconditioner function API
    • Defining Custom Operators
      • Defining a custom zero operator
      • Defining an operator from scratch
      • Defining an operator the easy way
      • Comparison of the two approaches

    Developer Documentation

    • Contributing to NetKet
      • Ways to contribute
      • Contributing code using pull requests
      • NetKet pull request checklist
        • Single-change commits and pull requests
        • Python coding style
        • Docstrings and Type Hints
        • Visibility of public API
        • Full GitHub test suite
    • Writing Tests
      • Test structure and common files.
      • Tests and MPI

    API documentation

    • API Stability
      • Public API Definition
      • Netket.nn module
      • Storing the environment
    • Public API
      • Graph
        • netket.graph.AbstractGraph
        • netket.graph.Graph
        • netket.graph.Lattice
        • netket.graph.Edgeless
        • netket.graph.Hypercube
        • netket.graph.lattice.LatticeSite
        • netket.graph.Chain
        • netket.graph.Grid
      • Hilbert
        • netket.hilbert.AbstractHilbert
        • netket.hilbert.ContinuousHilbert
        • netket.hilbert.DiscreteHilbert
        • netket.hilbert.HomogeneousHilbert
        • netket.hilbert.CustomHilbert
        • netket.hilbert.TensorHilbert
        • netket.hilbert.DoubledHilbert
        • netket.hilbert.Spin
        • netket.hilbert.Qubit
        • netket.hilbert.Fock
        • netket.hilbert.Particle
      • Operators
        • netket.operator.AbstractOperator
        • netket.operator.DiscreteOperator
        • netket.operator.BoseHubbard
        • netket.operator.GraphOperator
        • netket.operator.LocalOperator
        • netket.operator.Ising
        • netket.operator.Heisenberg
        • netket.operator.PauliStrings
        • netket.operator.LocalLiouvillian
        • Pre-defined operators
          • 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
        • Continuous space operators
          • netket.operator.ContinuousOperator
          • netket.operator.KineticEnergy
          • netket.operator.PotentialEnergy
          • netket.operator.SumOperator
      • Exact solvers
        • netket.exact.full_ed
        • netket.exact.lanczos_ed
        • netket.exact.steady_state
      • Sampler
        • Generic API
          • netket.sampler.sampler_state
          • netket.sampler.reset
          • netket.sampler.sample_next
          • netket.sampler.sample
          • netket.sampler.samples
        • List of Samplers
          • netket.sampler.Sampler
          • netket.sampler.ExactSampler
          • netket.sampler.MetropolisSampler
          • netket.sampler.MetropolisSamplerNumpy
          • netket.experimental.sampler.MetropolisPtSampler
          • netket.sampler.MetropolisLocal
          • netket.sampler.MetropolisExchange
          • netket.sampler.MetropolisHamiltonian
          • netket.experimental.sampler.MetropolisLocalPt
          • netket.experimental.sampler.MetropolisExchangePt
          • netket.sampler.ARDirectSampler
        • Transition Rules
          • netket.sampler.MetropolisRule
          • netket.sampler.rules.LocalRule
          • netket.sampler.rules.ExchangeRule
          • netket.sampler.rules.HamiltonianRule
          • netket.sampler.rules.HamiltonianRuleNumpy
          • netket.sampler.rules.CustomRuleNumpy
        • Internal State
          • netket.sampler.SamplerState
          • netket.sampler.MetropolisSamplerState
      • Pre-built models
        • 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
      • Model tools
        • netket.nn.Module
        • Linear Modules
          • netket.nn.Dense
          • netket.nn.DenseGeneral
          • netket.nn.DenseSymm
          • netket.nn.DenseEquivariant
          • netket.nn.Conv
          • netket.nn.Embed
          • netket.nn.MaskedDense1D
          • netket.nn.MaskedConv1D
          • netket.nn.MaskedConv2D
        • Activation functions
          • netket.nn.celu
          • netket.nn.elu
          • netket.nn.gelu
          • netket.nn.glu
          • netket.nn.log_sigmoid
          • netket.nn.log_softmax
          • netket.nn.relu
          • netket.nn.sigmoid
          • netket.nn.soft_sign
          • netket.nn.softmax
          • netket.nn.softplus
          • netket.nn.swish
          • netket.nn.log_cosh
          • netket.nn.reim_relu
          • netket.nn.reim_selu
      • Variational State Interface
        • netket.vqs.VariationalState
        • netket.vqs.ExactState
        • netket.vqs.MCState
        • netket.vqs.MCMixedState
        • netket.vqs.get_local_kernel
        • netket.vqs.get_local_kernel_arguments
      • Optimizer Module
        • Optimizers
          • netket.optimizer.Adam
          • netket.optimizer.AdaGrad
          • netket.optimizer.Sgd
          • netket.optimizer.Momentum
          • netket.optimizer.RmsProp
        • Preconditioners
          • netket.optimizer.SR
        • Quantum Geometric Tensor
          • netket.optimizer.qgt.QGTAuto
          • netket.optimizer.qgt.QGTOnTheFly
          • netket.optimizer.qgt.QGTJacobianPyTree
          • netket.optimizer.qgt.QGTJacobianDense
        • Dense solvers
          • netket.optimizer.solver.svd
          • netket.optimizer.solver.cholesky
          • netket.optimizer.solver.LU
          • netket.optimizer.solver.solve
      • Optimization drivers
        • netket.driver.AbstractVariationalDriver
        • netket.driver.VMC
        • netket.driver.SteadyState
      • Logging output
        • netket.logging.RuntimeLog
        • netket.logging.JsonLog
        • netket.logging.StateLog
        • netket.logging.TensorBoardLog
      • Utils
        • netket.utils.HashableArray
      • Callbacks
        • netket.callbacks.EarlyStopping
        • netket.callbacks.Timeout
    • Experimental API
      • Samplers
        • netket.experimental.sampler.MetropolisPtSampler
        • netket.experimental.sampler.MetropolisLocalPt
        • netket.experimental.sampler.MetropolisExchangePt
        • netket.experimental.sampler.MetropolisSamplerPmap
      • Variational State Interface
        • netket.experimental.vqs.variables_from_file
        • netket.experimental.vqs.variables_from_tar
      • Time Evolution Driver
        • netket.experimental.driver.TDVP
      • ODE Integrators
      • Fermions
        • netket.experimental.hilbert.SpinOrbitalFermions
        • netket.experimental.operator.FermionOperator2nd
        • netket.experimental.operator.fermion.create
        • netket.experimental.operator.fermion.destroy
        • netket.experimental.operator.fermion.number

    Back to top

    © Copyright 2019-2021, The Netket authors - All rights reserved.
    Created using Sphinx 3.5.4.