From 5cfc87010d8496f39c194647632e4c27e28e4f89 Mon Sep 17 00:00:00 2001 From: Gerry Chen Date: Tue, 19 Apr 2022 16:10:36 -0400 Subject: [PATCH] Add comment to docstring of `gtsam_optimize` --- python/gtsam/utils/logging_optimizer.py | 1 + 1 file changed, 1 insertion(+) diff --git a/python/gtsam/utils/logging_optimizer.py b/python/gtsam/utils/logging_optimizer.py index 1e55ce990..d2cd9b9f6 100644 --- a/python/gtsam/utils/logging_optimizer.py +++ b/python/gtsam/utils/logging_optimizer.py @@ -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