Skip to content

Commit a52a9bb

Browse files
committed
fix doc
1 parent 79aa238 commit a52a9bb

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

python/ffsim/optimize/stochastic_reconfiguration.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,10 @@ def minimize_stochastic_reconfiguration(
6060
epsilon: Increment to use for approximating the gradient using
6161
finite difference.
6262
gtol: Convergence threshold for the norm of the projected gradient.
63-
variation: Hyperparameter controlling the size of parameter variations
63+
variation: TODO Hyperparameter controlling the size of parameter variations
6464
used in the linear expansion of the wavefunction. Its value must be
65-
strictly between 0 and 1. A larger value results in larger variations.
66-
optimize_variation; Whether to optimize the `variation` hyperparameter
65+
positive.
66+
optimize_variation: Whether to optimize the `variation` hyperparameter
6767
in each iteration. Optimizing hyperparameters incurs more function and
6868
energy evaluations in each iteration, but may improve convergence.
6969
The optimization is performed using `scipy.optimize.minimize`_.

0 commit comments

Comments
 (0)