ing-bank · sbrugman · Jul 4, 2022 · Jun 2, 2022 · Jun 2, 2022 · Jun 2, 2022
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -26,3 +26,17 @@ repos:
     rev: v1.12.1
     hooks:
     -   id: blacken-docs
+-   repo: local
+    hooks:
+    -   id: docautogenerate
+        name: docsautogenerate
+        entry: bash -c 'cd ./docs/ && bash autogenerate.sh'
+        language: system
+-   repo: https://github.com/nbQA-dev/nbQA
+    rev: 1.3.1
+    hooks:
+    -   id: nbqa-black
+    -   id: nbqa-pyupgrade
+        args: ['--py36-plus']
+    -   id: nbqa-isort
+        args: ['--profile=black']
diff --git a/docs/source/comparisons.rst b/docs/source/comparisons.rst
@@ -35,3 +35,19 @@ The code below demonstrates how this could be achieved:
         return np.sum(np.abs(p - q))
 
 If you developed a custom comparison that could be generically used, then please considering contributing it to the package.
+
+Comparison settings
+-------------------
+
+Whenever a comparison has parameters, it is possible to alter them globally:
+
+.. code-block:: python
+
+    from functools import partial
+
+    from popmon.analysis.comparison.comparison_registry import Comparisons
+
+    # Set the max_res_bound to 5 (default 7) for the chi2 comparison function
+    Comparisons.update_func(
+        "chi2", partial(Comparisons.get_func("chi2"), max_res_bound=5.0)
+    )
diff --git a/docs/source/configuration.rst b/docs/source/configuration.rst
@@ -30,15 +30,22 @@ in four different ways:
 
     .. code-block:: python
 
+      settings = Settings()
+      settings.comparison.window = 10
+      settings.comparison.shift = 1
+
       # generate stability report with specific monitoring rules
-      report = df.pm_stability_report(reference_type="rolling", window=10, shift=1)
+      report = df.pm_stability_report(reference_type="rolling", settings=settings)
 
 4. Using an expanding window on all preceding time slots within the same DataFrame. This is also a dynamic method, with variable window size. All the available previous time slots are used. For example, if we have 2 time slots available and shift=1, window size will be 1 (so the previous slot is the reference), while if we have 10 time slots and shift=1, window size will be 9 (and all previous time slots are reference).
 
     .. code-block:: python
 
+      settings = Settings()
+      settings.comparison.shift = 1
+
       # generate stability report with specific monitoring rules
-      report = df.pm_stability_report(reference_type="expanding", shift=1)
+      report = df.pm_stability_report(reference_type="expanding", settings=settings)
 
 Note that, by default, popmon also performs a rolling comparison of the histograms in each time period with those in the
 previous time period. The results of these comparisons contain the term "prev1", and are found in the comparisons section
@@ -111,8 +118,11 @@ When generating a report, they can be provided as a dictionary:
 
 .. code-block:: python
 
+  settings = Settings()
+  settings.monitoring.monitoring_rules = your_monitoring_rules
+
   # generate stability report with specific monitoring rules
-  report = df.pm_stability_report(monitoring_rules=your_monitoring_rules)
+  report = df.pm_stability_report(settings=settings)
 
 When not provided, the default setting is:
 
@@ -168,8 +178,11 @@ When generating a report, the ``pull_rules`` can be provided as a dictionary:
 
 .. code-block:: python
 
+  settings = Settings()
+  settings.monitoring.pull_rules = your_pull_rules
+
   # generate stability report with specific monitoring rules
-  report = df.pm_stability_report(pull_rules=your_pull_rules)
+  report = df.pm_stability_report(settings=settings)
 
 The default for `pull_rules` is:
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -18,7 +18,6 @@ Contents
    comparisons
    tutorials
    configuration
-   tree
    developing
    changelog
 

diff --git a/docs/source/popmon.alerting.rst b/docs/source/popmon.alerting.rst
@@ -20,7 +20,6 @@ popmon.alerting.compute\_tl\_bounds module
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------
 

diff --git a/docs/source/popmon.analysis.comparison.rst b/docs/source/popmon.analysis.comparison.rst
@@ -4,6 +4,14 @@ popmon.analysis.comparison package
 Submodules
 ----------
 
+popmon.analysis.comparison.comparisons module
+---------------------------------------------
+
+.. automodule:: popmon.analysis.comparison.comparisons
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 popmon.analysis.comparison.hist\_comparer module
 ------------------------------------------------
 
@@ -12,7 +20,6 @@ popmon.analysis.comparison.hist\_comparer module
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------
 

diff --git a/docs/source/popmon.analysis.profiling.rst b/docs/source/popmon.analysis.profiling.rst
@@ -12,6 +12,14 @@ popmon.analysis.profiling.hist\_profiler module
    :undoc-members:
    :show-inheritance:
 
+popmon.analysis.profiling.profiles module
+-----------------------------------------
+
+.. automodule:: popmon.analysis.profiling.profiles
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 popmon.analysis.profiling.pull\_calculator module
 -------------------------------------------------
 
@@ -20,7 +28,6 @@ popmon.analysis.profiling.pull\_calculator module
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------
 

diff --git a/docs/source/popmon.analysis.rst b/docs/source/popmon.analysis.rst
@@ -5,6 +5,7 @@ Subpackages
 -----------
 
 .. toctree::
+   :maxdepth: 4
 
    popmon.analysis.comparison
    popmon.analysis.profiling
@@ -44,7 +45,6 @@ popmon.analysis.merge\_statistics module
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------
 

diff --git a/docs/source/popmon.base.rst b/docs/source/popmon.base.rst
@@ -20,6 +20,13 @@ popmon.base.pipeline module
    :undoc-members:
    :show-inheritance:
 
+popmon.base.registry module
+---------------------------
+
+.. automodule:: popmon.base.registry
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 Module contents
 ---------------

diff --git a/docs/source/popmon.decorators.rst b/docs/source/popmon.decorators.rst
@@ -0,0 +1,29 @@
+popmon.decorators package
+=========================
+
+Submodules
+----------
+
+popmon.decorators.pandas module
+-------------------------------
+
+.. automodule:: popmon.decorators.pandas
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+popmon.decorators.spark module
+------------------------------
+
+.. automodule:: popmon.decorators.spark
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: popmon.decorators
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/popmon.hist.filling.rst b/docs/source/popmon.hist.filling.rst
@@ -1,59 +1,6 @@
 popmon.hist.filling package
 ===========================
 
-Submodules
-----------
-
-popmon.hist.filling.histogram\_filler\_base module
---------------------------------------------------
-
-.. automodule:: popmon.hist.filling.histogram_filler_base
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-popmon.hist.filling.make\_histograms module
--------------------------------------------
-
-.. automodule:: popmon.hist.filling.make_histograms
-   :members:
-   :undoc-members:
-   :show-inheritance:
-   :noindex:
-
-popmon.hist.filling.numpy\_histogrammar module
-----------------------------------------------
-
-.. automodule:: popmon.hist.filling.numpy_histogrammar
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-popmon.hist.filling.pandas\_histogrammar module
------------------------------------------------
-
-.. automodule:: popmon.hist.filling.pandas_histogrammar
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-popmon.hist.filling.spark\_histogrammar module
-----------------------------------------------
-
-.. automodule:: popmon.hist.filling.spark_histogrammar
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-popmon.hist.filling.utils module
---------------------------------
-
-.. automodule:: popmon.hist.filling.utils
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-
 Module contents
 ---------------
 

diff --git a/docs/source/popmon.hist.rst b/docs/source/popmon.hist.rst
@@ -5,6 +5,7 @@ Subpackages
 -----------
 
 .. toctree::
+   :maxdepth: 4
 
    popmon.hist.filling
 
@@ -19,23 +20,14 @@ popmon.hist.hist\_splitter module
    :undoc-members:
    :show-inheritance:
 
-popmon.hist.histogram module
-----------------------------
+popmon.hist.hist\_utils module
+------------------------------
 
-.. automodule:: popmon.hist.histogram
+.. automodule:: popmon.hist.hist_utils
    :members:
    :undoc-members:
    :show-inheritance:
 
-popmon.hist.patched\_histogrammer module
-----------------------------------------
-
-.. automodule:: popmon.hist.patched_histogrammer
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-
 Module contents
 ---------------
 

diff --git a/docs/source/popmon.io.rst b/docs/source/popmon.io.rst
@@ -28,7 +28,6 @@ popmon.io.json\_reader module
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------
 

diff --git a/docs/source/popmon.pipeline.rst b/docs/source/popmon.pipeline.rst
@@ -44,7 +44,6 @@ popmon.pipeline.report\_pipelines module
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------
 

diff --git a/docs/source/popmon.rst b/docs/source/popmon.rst
@@ -5,10 +5,12 @@ Subpackages
 -----------
 
 .. toctree::
+   :maxdepth: 4
 
    popmon.alerting
    popmon.analysis
    popmon.base
+   popmon.decorators
    popmon.hist
    popmon.io
    popmon.pipeline
@@ -35,6 +37,14 @@ popmon.resources module
    :undoc-members:
    :show-inheritance:
 
+popmon.utils module
+-------------------
+
+.. automodule:: popmon.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 popmon.version module
 ---------------------
 
@@ -43,7 +53,6 @@ popmon.version module
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------
 

diff --git a/docs/source/popmon.stats.rst b/docs/source/popmon.stats.rst
@@ -12,7 +12,6 @@ popmon.stats.numpy module
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------
 

diff --git a/docs/source/popmon.stitching.rst b/docs/source/popmon.stitching.rst
@@ -12,7 +12,6 @@ popmon.stitching.hist\_stitcher module
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------
-Original file line number
+Diff line change
@@ Expand Up / @@ -20,7 +20,6 @@ popmon.alerting.compute\_tl\_bounds module @@
        :undoc-members:
        :show-inheritance:
     Module contents
     ---------------
@@ Expand Down @@