class netket.experimental.driver.TDVP#

Bases: netket.driver.abstract_variational_driver.AbstractVariationalDriver

Variational time evolution based on the time-dependent variational principle which, when used with Monte Carlo sampling via netket.vqs.MCState, is the time-dependent VMC (t-VMC) method.

Inheritance diagram of netket.experimental.driver.TDVP
__init__(operator, variational_state, integrator, *, t0=0.0, propagation_type='real', qgt=None, linear_solver=None, linear_solver_restart=False, error_norm='euclidean')[source]#

Initializes the time evolution driver.

  • operator (AbstractOperator) – The generator of the dynamics (Hamiltonian for pure states, Lindbladian for density operators).

  • variational_state (VariationalState) – The variational state.

  • integrator (RKIntegratorConfig) – Configuration of the algorithm used for solving the ODE.

  • t0 (float) – Initial time at the start of the time evolution.

  • propagation_type – Determines the equation of motion: “real” for the real-time Schödinger equation (SE), “imag” for the imaginary-time SE.

  • qgt (Optional[LinearOperator]) – The QGT specification.

  • linear_solver – The solver for solving the linear system determining the time evolution.

  • linear_solver_restart (bool) – If False (default), the last solution of the linear system is used as initial value in subsequent steps.

  • error_norm (Union[str, Callable]) – Norm function used to calculate the error with adaptive integrators. Can be either “euclidean” for the standard L2 vector norm \(w^\dagger w\), “maximum” for the maximum norm \(\max_i |w_i|\) or “qgt”, in which case the scalar product induced by the QGT \(S\) is used to compute the norm \(\Vert w \Vert^2_S = w^\dagger S w\) as suggested in PRL 125, 100503 (2020). Additionally, it possible to pass a custom function with signature norm(x: PyTree) -> float which maps a PyTree of parameters x to the corresponding norm. Note that norm is used in jax.jit-compiled code.


Current time step.


Returns the Callable function computing the error of the norm used for adaptive timestepping by the integrator.

Can be set to a Callable accepting a pytree and returning a real scalar, or a string between ‘euclidean’, ‘maximum’ or ‘qgt’.

Return type



The generator of the dynamics as a function with signature generator(t: float) -> AbstractOperator

Return type



The underlying integrator which computes the time steps.


The optimizer used to update the parameters at every iteration.


Returns the machine that is optimized by this driver.


Returns a monotonic integer labelling all the steps performed by this driver. This can be used, for example, to identify the line in a log file.


Current time.


The initial time set when the driver was created.


Advance the time propagation by T to self.t + T.


T (float) – Length of the integration interval.


Return MCMC statistics for the expectation value of observables in the current state of the driver.


observables – A pytree of operators for which statistics should be computed.


A pytree of the same structure as the input, containing MCMC statistics for the corresponding operators as leaves.


Returns an info string used to print information to screen about this driver.

iter(T, *, tstops=None)[source]#

Returns a generator which advances the time evolution for an interval of length T, stopping at tstops.

  • T (float) – Length of the integration interval.

  • tstops (Optional[Sequence[float]]) – A sequence of stopping times, each within the intervall [self.t0, self.t0 + T], at which this method will stop and yield. By default, a stop is performed after each time step (at potentially varying step size if an adaptive integrator is used).


The current step count.

ode(t=None, w=None)[source]#

Evaluates the TDVP equation of motion

\[G(w) \dot w = \gamma F(w, t)\]

where \(G(w)\) is the QGT, \(F(w, t)\) the gradient of self.generator and \(\gamma\) one of \(\gamma = -1\) (imaginary-time dynamics for MCState), \(\gamma = -i\) (real-time dynamics for MCState), or \(\gamma = 1\) (real-time dynamics for MCMixedState).

  • t – Time (defaults to self.t).

  • w – Variational parameters (defaults to self.state.parameters).


The time-derivative \(\dot w\).


Resets the driver. Concrete drivers should also call super().reset() to ensure that the step count is set to 0.

run(T, out=None, obs=None, *, tstops=None, show_progress=True, callback=None)[source]#

Runs the time evolution.

By default uses netket.logging.JsonLog. To know about the output format check it’s documentation. The logger object is also returned at the end of this function so that you can inspect the results without reading the json output.

  • T – The integration time period.

  • out – A logger object, or an iterable of loggers, to be used to store simulation log and data. If this argument is a string, it will be used as output prefix for the standard JSON logger.

  • obs – An iterable containing the observables that should be computed.

  • tstops – A sequence of stopping times, each within the intervall [self.t0, self.t0 + T], at which the driver will stop and perform estimation of observables, logging, and excecute the callback function. By default, a stop is performed after each time step (at potentially varying step size if an adaptive integrator is used).

  • show_progress – If true displays a progress bar (default=True)

  • callback – Callable or list of callable callback functions to be executed at each stoping time.


Updates the parameters of the machine using the optimizer in this driver


dp – the pytree containing the updates to the parameters