Revised description on the structure of evaluation results
Project: http://git-wip-us.apache.org/repos/asf/climate/repo Commit: http://git-wip-us.apache.org/repos/asf/climate/commit/19e8d0c0 Tree: http://git-wip-us.apache.org/repos/asf/climate/tree/19e8d0c0 Diff: http://git-wip-us.apache.org/repos/asf/climate/diff/19e8d0c0 Branch: refs/heads/master Commit: 19e8d0c052801b9b45e4d3db47877492395ed751 Parents: c088cfa Author: huikyole <[email protected]> Authored: Wed Aug 12 08:41:06 2015 -0700 Committer: huikyole <[email protected]> Committed: Wed Aug 12 08:41:06 2015 -0700 ---------------------------------------------------------------------- ocw/evaluation.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/climate/blob/19e8d0c0/ocw/evaluation.py ---------------------------------------------------------------------- diff --git a/ocw/evaluation.py b/ocw/evaluation.py index 11c1ae3..becced1 100644 --- a/ocw/evaluation.py +++ b/ocw/evaluation.py @@ -95,8 +95,10 @@ class Evaluation(object): self._subregions = subregions #: A list containing the results of running regular metric evaluations. - #: The shape of results is ``(num_target_datasets, num_metrics)`` if - #: the user doesn't specify subregion information. Otherwise the shape + #: The shape of results list is ``len(results_list) = num_metrics``. + #: Each element of the list is a numpy.Masked array whose first dimension + #: is num_target_datasets. + #: If the user specify subregion information, the shape #: is ``(num_target_datasets, num_metrics, num_subregions)``. self.results = [] #: A list containing the results of running the unary metric
