[Doc] Add docstring of evaluator's history (#559)

*Issue #, if available:* *Description of changes:* This PR rewrite the docstring of InstanceEvaluator's get history function. This get history method was used in the Standalone Notebook example. By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice. --------- Co-authored-by: Ubuntu <[email protected]>
awslabs · Oct 13, 2023 · 7e7687e · 7e7687e
1 parent 0569508
commit 7e7687e
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/docs/source/_templates/evaltemplate.rst b/docs/source/_templates/evaltemplate.rst
@@ -10,4 +10,4 @@
     :members: prepare_data, get_node_feats, get_edge_feats, get_labels, forward, get_sparse_params, 
               get_general_dense_parameters, get_lm_dense_parameters, save_model, remove_saved_model,
               save_topk_models, get_best_model_path, restore_model, fit, eval, infer, evaluate,
-              do_eval, compute_score, predict
+              do_eval, compute_score, predict, history
diff --git a/python/graphstorm/eval/evaluator.py b/python/graphstorm/eval/evaluator.py
@@ -328,7 +328,14 @@ def best_iter_num(self):
 
     @property
     def history(self):
-        """ Evaluation history"""
+        """ Evaluation history
+        
+            Returns
+            -------
+            A list of evaluation history in training. The detailed contents of the list rely
+            on specific Evaluators. For example, ``GSgnnRegressionEvaluator`` and
+            ``GSgnnAccEvaluator`` add a tuple of validation and testing score as one list element.
+        """
         return self._history
 
 class GSgnnRegressionEvaluator(GSgnnInstanceEvaluator):