Skip to content

Commit

Permalink
Utilities doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
KulikDM committed Nov 12, 2023
1 parent b82c14d commit a875c6b
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 6 deletions.
13 changes: 10 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -278,9 +278,9 @@ Unsupervised Anomaly Detection. <https://arxiv.org/abs/2210.10487>`_
| COMB | Thresholder Combination | None | `pythresh.thresholds.comb module <https://pythresh.readthedocs.io/en/latest/pythresh.thresholds.html#module-pythresh.thresholds.comb>`_ |
+-----------+-------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+

******************************
Implementations & Benchmarks
******************************
******************************************
Implementations, Benchmarks, & Utilities
******************************************

**The comparison among implemented models and general implementation**
is made available below
Expand All @@ -293,6 +293,13 @@ smallest uncertainty about its mean and is the most robust (best least
accurate prediction). However, for interpretability and general
performance the ``FILTER`` thresholder is a good fit.

Further utilities are available for assiting in the selection of the
most optimal outlier detection and thresholding methods `ranking
<https://pythresh.readthedocs.io/en/latest/ranking.html>`_ as well as
determining the confidence with regards to the selected thresholding
method `thresholding confidence
<https://pythresh.readthedocs.io/en/latest/confidence.html>`_

----

For Jupyter Notebooks, please navigate to `notebooks
Expand Down
13 changes: 10 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,16 +90,23 @@ complex mathematical methods that involve graph theory and topology.
----

**************
Benchmarking
**************
**************************
Benchmarking & Utilities
**************************

Benchmarking has been done on all the thresholders and it was found
that the ``META`` thresholder performed best while the ``CLF`` thresholder
provided the smallest uncertainty about its mean and is the most robust
(best least accurate prediction). However, for interpretability and
general performance the ``FILTER`` thresholder is a good fit.

Further utilities are available for assiting in the selection of the
most optimal outlier detection and thresholding methods `ranking
<https://pythresh.readthedocs.io/en/latest/ranking.html>`_ as well as
determining the confidence with regards to the selected thresholding
method `thresholding confidence
<https://pythresh.readthedocs.io/en/latest/confidence.html>`_

----

************************
Expand Down

0 comments on commit a875c6b

Please sign in to comment.