docs: profiles in table

ing-bank · Jul 5, 2022 · 65459af · 65459af
1 parent b5b7626
commit 65459af
Showing 1 changed file with 24 additions and 26 deletions.
diff --git a/docs/source/profiles.rst b/docs/source/profiles.rst
@@ -8,30 +8,29 @@ Available profiles
 ------------------
 The following metrics are implemented:
 
-Any dimension
-
-- count
-
-1D histogram, all types:
-
-- filled
-- underflow, overflow
-- nan
-
-1D histogram, numeric:
-
-- mean
-- 1%, 5%, 16%, 50% (median), 84%, 95%, 99% percentiles
-- std
-- min, max
-
-1D histogram, categorical
-
-- fraction of true
-
-2D histogram:
-
-- phik
++------------+-----------------+-------------------------------------------------------+
+| Dimension  | Histogram Type  | Metric                                                |
++============+=================+=======================================================+
+| Any        | Any             | Count                                                 |
++------------+-----------------+-------------------------------------------------------+
+| 1D         | Any             | Filled                                                |
++------------+-----------------+-------------------------------------------------------+
+| 1D         | Any             | Underflow, Overflow                                   |
++------------+-----------------+-------------------------------------------------------+
+| 1D         | Any             | NaN                                                   |
++------------+-----------------+-------------------------------------------------------+
+| 1D         | Numeric         | Mean                                                  |
++------------+-----------------+-------------------------------------------------------+
+| 1D         | Numeric         | 1%, 5%, 16%, 50% (median), 84%, 95%, 99% percentiles  |
++------------+-----------------+-------------------------------------------------------+
+| 1D         | Numeric         | Standard deviation                                    |
++------------+-----------------+-------------------------------------------------------+
+| 1D         | Numeric         | Min, Max                                              |
++------------+-----------------+-------------------------------------------------------+
+| 1D         | Categorical     | Fraction of True                                      |
++------------+-----------------+-------------------------------------------------------+
+| 2D         | Any             | PhiK Correlation                                      |
++------------+-----------------+-------------------------------------------------------+
 
 
 Custom profiles
@@ -65,8 +64,7 @@ Variations:
         result1, result2 = your_logic(hist)
         return result1, result2
 
-- A profile may work on the histogram, or on the value counts/labels (also for efficiency).
-This occurs when the ``htype`` parameter is passed (1D only)
+- A profile may work on the histogram, or on the value counts/labels (also for efficiency). This occurs when the ``htype`` parameter is passed (1D only)
 
 .. code-block:: python