climate-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jo...@apache.org
Subject svn commit: r1535866 - in /incubator/climate/trunk/docs/source: index.rst ocw/metrics.rst
Date Fri, 25 Oct 2013 20:46:30 GMT
Author: joyce
Date: Fri Oct 25 20:46:30 2013
New Revision: 1535866

URL: http://svn.apache.org/r1535866
Log:
CLIMATE-315 - Add metrics.py to Sphinx build

- Add metrics.net. This needs more attention in the future to make it
  more user friendly. At the moment it only shows basic class docstring
  information.
- Add the metrics.py documentation to the index.

Added:
    incubator/climate/trunk/docs/source/ocw/metrics.rst
Modified:
    incubator/climate/trunk/docs/source/index.rst

Modified: incubator/climate/trunk/docs/source/index.rst
URL: http://svn.apache.org/viewvc/incubator/climate/trunk/docs/source/index.rst?rev=1535866&r1=1535865&r2=1535866&view=diff
==============================================================================
--- incubator/climate/trunk/docs/source/index.rst (original)
+++ incubator/climate/trunk/docs/source/index.rst Fri Oct 25 20:46:30 2013
@@ -14,6 +14,7 @@ Contents:
    ocw/dataset
    ocw/dataset_processor
    ocw/evaluation
+   ocw/metrics
 
 
 Indices and tables

Added: incubator/climate/trunk/docs/source/ocw/metrics.rst
URL: http://svn.apache.org/viewvc/incubator/climate/trunk/docs/source/ocw/metrics.rst?rev=1535866&view=auto
==============================================================================
--- incubator/climate/trunk/docs/source/ocw/metrics.rst (added)
+++ incubator/climate/trunk/docs/source/ocw/metrics.rst Fri Oct 25 20:46:30 2013
@@ -0,0 +1,22 @@
+Metrics Module
+**************
+
+UnaryMetric
+===========
+.. autoclass:: metrics.UnaryMetric
+    :members:
+
+BinaryMetric
+============
+.. autoclass:: metrics.BinaryMetric
+    :members:
+
+Bias
+====
+.. autoclass:: metrics.Bias
+    :members:
+
+TemporalStdDev
+==============
+.. autoclass:: metrics.TemporalStdDev
+    :members:



Mime
View raw message