Skip to content

Commit

Permalink
Add comment to docstring of gtsam_optimize
Browse files Browse the repository at this point in the history
  • Loading branch information
gchenfc committed Apr 19, 2022
1 parent 71aa20f commit 5cfc870
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions python/gtsam/utils/logging_optimizer.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ def gtsam_optimize(optimizer,
""" Given an optimizer and its params, iterate until convergence.
After each iteration, hook(optimizer) is called.
After the function, use values and errors to get the result.
Optimizer must have been created with the same params as the one passed into this function!
Arguments:
optimizer {NonlinearOptimizer} -- Nonlinear optimizer
params {NonlinearOptimizarParams} -- Nonlinear optimizer parameters
Expand Down

0 comments on commit 5cfc870

Please sign in to comment.