Updated the documentation for some functions

smeznar · Jan 27, 2025 · 4501f82 · 4501f82
1 parent 9627e6a
commit 4501f82
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/SRToolkit/evaluation/parameter_estimator.py b/SRToolkit/evaluation/parameter_estimator.py
@@ -80,8 +80,8 @@ def estimate_parameters(self, expr: Union[List[str], Node]) -> Tuple[float, np.n
             True
 
         Args:
-            expr: A list of strings representing the expression to be evaluated. The expression should include the
-                  symbol 'C' for constants whose values need to be estimated.
+            expr: An expression. This should either be an instance of SRToolkit.utils.expression_tree.Node or a list of
+                  tokens in the infix notation representing the expression to be evaluated.
 
         Returns:
             the root mean square error (RMSE) of the optimized expression.

diff --git a/SRToolkit/evaluation/sr_evaluator.py b/SRToolkit/evaluation/sr_evaluator.py
@@ -85,7 +85,8 @@ def evaluate_expr(self, expr: Union[List[str], Node]) -> float:
             True
 
         Args:
-            expr: A list of strings representing the expression in infix notation.
+            expr: An expression. This should be an istance of the SRToolkit.utils.expression_tree.Node class or a list
+                  of tokens in the infix notation.
 
         Returns:
             The root mean square error of the expression.