12345qiupeng
/
gtsam
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add comment to docstring of `gtsam_optimize`

release/4.3a0
Gerry Chen 2022-04-19 16:10:36 -04:00
parent 71aa20ff33
commit 5cfc87010d
No known key found for this signature in database
GPG Key ID: E9845092D3A57286
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
python/gtsam/utils/logging_optimizer.py
View File

@ -39,6 +39,7 @@ def gtsam_optimize(optimizer,
""" Given an optimizer and its params, iterate until convergence. """ Given an optimizer and its params, iterate until convergence.
After each iteration, hook(optimizer) is called. After each iteration, hook(optimizer) is called.
After the function, use values and errors to get the result. 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: Arguments:
optimizer {NonlinearOptimizer} -- Nonlinear optimizer optimizer {NonlinearOptimizer} -- Nonlinear optimizer
params {NonlinearOptimizarParams} -- Nonlinear optimizer parameters params {NonlinearOptimizarParams} -- Nonlinear optimizer parameters