docs: registry snippet to list available profiles/comparisons

Author: sbrugman

docs/source/comparisons.rst

@@ -26,6 +26,15 @@ A rich set of the most frequently used comparisons is available out-of-the-box:
 | Any        | Any             | Maximum probability difference  |
 +------------+-----------------+---------------------------------+
 
+The comparisons registry can be consulted for available comparisons:
+
+.. code-block:: python
+
+    from popmon.analysis import Comparisons
+
+    print(Comparisons.get_keys())
+
+
 Custom comparisons
 ------------------
 

docs/source/profiles.rst

@@ -15,10 +15,14 @@ The following metrics are implemented:
 +------------+-----------------+-------------------------------------------------------+
 | 1D         | Any             | Filled                                                |
 +------------+-----------------+-------------------------------------------------------+
+| 1D         | Any             | Distinct                                              |
++------------+-----------------+-------------------------------------------------------+
 | 1D         | Any             | Underflow, Overflow                                   |
 +------------+-----------------+-------------------------------------------------------+
 | 1D         | Any             | NaN                                                   |
 +------------+-----------------+-------------------------------------------------------+
+| 1D         | Any             | Mode                                                  |
++------------+-----------------+-------------------------------------------------------+
 | 1D         | Numeric         | Mean                                                  |
 +------------+-----------------+-------------------------------------------------------+
 | 1D         | Numeric         | 1%, 5%, 16%, 50% (median), 84%, 95%, 99% percentiles  |
@@ -32,6 +36,14 @@ The following metrics are implemented:
 | 2D         | Any             | PhiK Correlation                                      |
 +------------+-----------------+-------------------------------------------------------+
 
+The comparisons registry can be consulted for available comparisons:
+
+.. code-block:: python
+
+    from popmon.analysis import Profiles
+
+    print(Profiles.get_keys())
+
 
 Custom profiles
 ---------------