pyod 3.2.1__tar.gz → 3.4.0__tar.gz

{pyod-3.2.1/pyod.egg-info → pyod-3.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyod
-Version: 3.2.1
+Version: 3.4.0
 Summary: A Python library for anomaly detection across tabular, time series, graph, text, and image data. 60+ detectors, benchmark-backed ADEngine orchestration, and an agentic workflow for AI agents.
 Author-email: Yue Zhao <yzhao062@gmail.com>
 License-Expression: BSD-2-Clause
@@ -122,7 +122,7 @@ Python Outlier Detection (PyOD) 3
 
 -----
 
-    **PyOD is now agentic.** Any AI agent can drive an expert-level anomaly detection investigation on your data in plain English. The classic ``fit``/``predict`` API stays unchanged.
+    **PyOD is agent-ready.** Claude Code and Codex can use the ``od-expert`` skill to drive ADEngine investigations, while MCP-compatible agents can query PyOD's detector knowledge and planning tools. The classic ``fit``/``predict`` API stays unchanged.
 
 -----
 
@@ -133,7 +133,7 @@ Pillar                       What it means
 ===========================  ========================================================================================
 Multi-Modal                  60+ detectors across **tabular, time series, graph, text, and image** data, one API
 Full Lifecycle               From raw data to explained anomalies and next-step guidance in a single call
-Agentic                      Ask in plain English, and AI agents run expert-level detection without OD expertise
+Agentic                      ``od-expert`` turns natural-language requests into ADEngine workflows; MCP exposes structured tools for other agents
 Most Used                    38+ million downloads; benchmark-backed routing (ADBench, TSB-AD, BOND, NLP-ADBench)
 ===========================  ========================================================================================
 
@@ -167,7 +167,7 @@ which agent stack you have installed (``~/.claude/`` for Claude Code,
 ``~/.codex/`` for Codex) and recommends the right install command.
 
 For conda, source install, dependency details, and troubleshooting,
-see the full `installation guide <https://pyod.readthedocs.io/en/latest/install.html>`_.
+see the full `installation guide <https://pyod.readthedocs.io/en/latest/install.html>`__.
 The legacy ``pyod-install-skill`` command from v3.0.0 still works as an
 alias for ``pyod install skill``.
 
@@ -191,7 +191,7 @@ Layer      Name                   When to use
 3          Agentic Investigation  You want an AI agent to drive OD through natural conversation           `Layer 3 walkthrough <https://pyod.readthedocs.io/en/latest/examples/agentic.html>`__
 =========  =====================  ======================================================================  =======================================
 
-Layers 2 and 3 are powered by ``ADEngine``, PyOD's intelligent orchestration core. Layer 3 adds two agentic activation paths: the ``od-expert`` skill for Claude Code and Codex, and an MCP server (``python -m pyod.mcp_server``) that works with any MCP-compatible LLM out of the box. See the Install block above for detailed setup instructions.
+Layers 2 and 3 are powered by ``ADEngine``, PyOD's intelligent orchestration core. The full multi-turn Layer 3 investigation flow is available through the ``od-expert`` skill for Claude Code and Codex. The MCP server (``python -m pyod.mcp_server``) exposes ten stateless tools for MCP-compatible LLMs, spanning knowledge queries (``list_detectors``, ``explain_detector``, ``compare_detectors``, ``get_benchmarks``), planning (``profile_data``, ``plan_detection``, ``build_detector``), and detection (``run_detection``, ``analyze_results``, ``explain_findings``); stateful ``investigate`` / ``iterate`` MCP tools are deferred.
 
 .. image:: https://raw.githubusercontent.com/yzhao062/pyod/development/docs/figs/agentic-demo.png
    :alt: PyOD 3 agentic investigation demo on cardiotocography dataset
@@ -201,7 +201,7 @@ Layers 2 and 3 are powered by ``ADEngine``, PyOD's intelligent orchestration cor
 The figure above shows a real 5-turn agentic conversation on the UCI Cardiotocography dataset. See the `full walkthrough <https://pyod.readthedocs.io/en/latest/examples/agentic.html>`__, runnable `agentic example <https://github.com/yzhao062/pyod/blob/development/examples/agentic_example.py>`__, or interactive `HTML demo <https://htmlpreview.github.io/?https://github.com/yzhao062/pyod/blob/development/examples/agentic_demo.html>`__.
 
 **PyOD Ecosystem & Resources**:
-`NLP-ADBench <https://github.com/USC-FORTIS/NLP-ADBench>`_ (NLP anomaly detection) | `TODS <https://github.com/datamllab/tods>`_ (time-series) | `PyGOD <https://pygod.org/>`_ (graph) | `ADBench <https://github.com/Minqi824/ADBench>`_ (benchmark) | `AD-LLM <https://arxiv.org/abs/2412.11142>`_ (LLM-based AD) [#Yang2024ad]_ | `Resources <https://github.com/yzhao062/anomaly-detection-resources>`_
+`NLP-ADBench <https://github.com/USC-FORTIS/NLP-ADBench>`__ (NLP anomaly detection) | `TODS <https://github.com/datamllab/tods>`__ (time-series) | `PyGOD <https://pygod.org/>`__ (graph) | `ADBench <https://github.com/Minqi824/ADBench>`__ (benchmark) | `AD-LLM <https://arxiv.org/abs/2412.11142>`__ (LLM-based AD) [#Yang2024ad]_ | `Resources <https://github.com/yzhao062/anomaly-detection-resources>`__
 
 ----
 
@@ -209,7 +209,7 @@ The figure above shows a real 5-turn agentic conversation on the UCI Cardiotocog
 About PyOD
 ^^^^^^^^^^
 
-PyOD, established in 2017, is the longest-running and most widely used Python library for anomaly detection. With `38+ million downloads <https://pepy.tech/project/pyod>`_, it serves both academic research (featured in `Analytics Vidhya <https://www.analyticsvidhya.com/blog/2019/02/outlier-detection-python-pyod/>`_, `KDnuggets <https://www.kdnuggets.com/2019/02/outlier-detection-methods-cheat-sheet.html>`_, and `Towards Data Science <https://towardsdatascience.com/anomaly-detection-for-dummies-15f148e559c1>`_) and commercial products.
+PyOD, established in 2017, is the longest-running and most widely used Python library for anomaly detection. With `38+ million downloads <https://pepy.tech/project/pyod>`__, it serves both academic research (featured in `Analytics Vidhya <https://www.analyticsvidhya.com/blog/2019/02/outlier-detection-python-pyod/>`__, `KDnuggets <https://www.kdnuggets.com/2019/02/outlier-detection-methods-cheat-sheet.html>`__, and `Towards Data Science <https://towardsdatascience.com/anomaly-detection-for-dummies-15f148e559c1>`__) and commercial products.
 
 V3 extends the library with ``ADEngine`` (intelligent orchestration) and the ``od-expert`` skill (agentic workflow), while keeping the classic ``fit``/``predict`` API fully backward-compatible. V3 is built on SUOD [#Zhao2021SUOD]_ for fast parallel training and numba JIT for per-model speedups.
 
@@ -218,21 +218,21 @@ V3 extends the library with ``ADEngine`` (intelligent orchestration) and the ``o
 ===================================  ===========================================================================
 Area                                 Examples
 ===================================  ===========================================================================
-Space & science                      European Space Agency `OPS-SAT spacecraft telemetry benchmark <https://www.nature.com/articles/s41597-025-05035-3>`_ (*Nature Scientific Data*, 2025) uses PyOD for all 30 algorithms.
-Enterprise deployment                Walmart (1M+ daily pricing updates, KDD 2019), Databricks (Kakapo framework integrating PyOD with MLflow/Hyperopt; insider-threat detection solution), IQVIA (123K+ pharmacy claims), Altair AI Studio, Ericsson (patent `WO2023166515A1 <https://patents.google.com/patent/WO2023166515A1>`_).
-Books                                `Outlier Detection in Python <https://www.manning.com/books/outlier-detection-in-python>`_ (Brett Kennedy, Manning); *Handbook of Anomaly Detection with Python* (Chris Kuo, Columbia); `Finding Ghosts in Your Data <https://link.springer.com/book/10.1007/978-1-4842-8870-2>`_ (Kevin Feasel, Apress).
-Courses                              DataCamp `Anomaly Detection in Python <https://www.datacamp.com/courses/anomaly-detection-in-python>`_ (19M+ platform learners), Manning `liveProject <https://www.manning.com/liveproject/using-pyod-and-ensembles-methods>`_, O'Reilly video edition, multiple Udemy courses.
-Podcasts                             `Talk Python To Me #497 <https://talkpython.fm/episodes/show/497/outlier-detection-with-python>`_, `Real Python Podcast #208 <https://realpython.com/podcasts/rpp/208/>`_.
-International                        Tutorials in 5 non-English languages: Chinese (CSDN, Zhihu, 搜狐, 机器之心, `aidoczh.com <https://www.aidoczh.com>`_ full doc translation), Japanese, Korean, German, Spanish.
+Space & science                      European Space Agency `OPS-SAT spacecraft telemetry benchmark <https://www.nature.com/articles/s41597-025-05035-3>`__ (*Nature Scientific Data*, 2025) uses PyOD for all 30 algorithms.
+Enterprise deployment                Walmart (1M+ daily pricing updates, KDD 2019), Databricks (Kakapo framework integrating PyOD with MLflow/Hyperopt; insider-threat detection solution), IQVIA (123K+ pharmacy claims), Altair AI Studio, Ericsson (patent `WO2023166515A1 <https://patents.google.com/patent/WO2023166515A1>`__).
+Books                                `Outlier Detection in Python <https://www.manning.com/books/outlier-detection-in-python>`__ (Brett Kennedy, Manning); *Handbook of Anomaly Detection with Python* (Chris Kuo, Columbia); `Finding Ghosts in Your Data <https://link.springer.com/book/10.1007/978-1-4842-8870-2>`__ (Kevin Feasel, Apress).
+Courses                              DataCamp `Anomaly Detection in Python <https://www.datacamp.com/courses/anomaly-detection-in-python>`__ (19M+ platform learners), Manning `liveProject <https://www.manning.com/liveproject/using-pyod-and-ensembles-methods>`__, O'Reilly video edition, multiple Udemy courses.
+Podcasts                             `Talk Python To Me #497 <https://talkpython.fm/episodes/show/497/outlier-detection-with-python>`__, `Real Python Podcast #208 <https://realpython.com/podcasts/rpp/208/>`__.
+International                        Tutorials in 5 non-English languages: Chinese (CSDN, Zhihu, 搜狐, 机器之心, `aidoczh.com <https://www.aidoczh.com>`__ full doc translation), Japanese, Korean, German, Spanish.
 ===================================  ===========================================================================
 
-See the `full impact page <https://pyod.readthedocs.io/en/latest/impact.html>`_ on Read the Docs for the complete list of citations, enterprise deployments, patents, and media coverage.
+See the `full impact page <https://pyod.readthedocs.io/en/latest/impact.html>`__ on Read the Docs for the complete list of citations, enterprise deployments, patents, and media coverage.
 
 **Citing PyOD**:
 
 If you use PyOD in a scientific publication, we would appreciate citations to the following paper(s):
 
-`PyOD 2: A Python Library for Outlier Detection with LLM-powered Model Selection <https://arxiv.org/abs/2412.12154>`_ is available as a preprint. If you use PyOD in a scientific publication, we would appreciate citations to the following paper::
+`PyOD 2: A Python Library for Outlier Detection with LLM-powered Model Selection <https://arxiv.org/abs/2412.12154>`__ is available as a preprint. If you use PyOD in a scientific publication, we would appreciate citations to the following paper::
 
     @inproceedings{chen2025pyod,
       title={Pyod 2: A python library for outlier detection with llm-powered model selection},
@@ -243,7 +243,7 @@ If you use PyOD in a scientific publication, we would appreciate citations to th
     }
 
 
-`PyOD paper <http://www.jmlr.org/papers/volume20/19-011/19-011.pdf>`_ is published in `Journal of Machine Learning Research (JMLR) <http://www.jmlr.org/>`_ (MLOSS track).::
+`PyOD paper <http://www.jmlr.org/papers/volume20/19-011/19-011.pdf>`__ is published in `Journal of Machine Learning Research (JMLR) <http://www.jmlr.org/>`__ (MLOSS track).::
 
     @article{zhao2019pyod,
         author  = {Zhao, Yue and Nasrullah, Zain and Li, Zheng},
@@ -261,18 +261,18 @@ or::
     Zhao, Y., Nasrullah, Z. and Li, Z., 2019. PyOD: A Python Toolbox for Scalable Outlier Detection. Journal of machine learning research (JMLR), 20(96), pp.1-7.
 
 
-For a broader perspective on anomaly detection, see our NeurIPS papers on `ADBench <https://arxiv.org/abs/2206.09426>`_ [#Han2022ADBench]_ and `ADGym <https://arxiv.org/abs/2309.15376>`_.
+For a broader perspective on anomaly detection, see our NeurIPS papers on `ADBench <https://arxiv.org/abs/2206.09426>`__ [#Han2022ADBench]_ and `ADGym <https://arxiv.org/abs/2309.15376>`__.
 
 
 **Table of Contents**:
 
-* `API Cheatsheet & Reference <#api-cheatsheet--reference>`_
-* `Benchmarks <#benchmarks>`_
-* `Implemented Algorithms <#implemented-algorithms>`_ (Tabular, Time Series, Graph, Embedding)
-* `Additional Topics <#additional-topics>`_ (Model Save/Load, SUOD, Thresholding)
-* `Quick Start for Outlier Detection <#quick-start-for-outlier-detection>`_
-* `How to Contribute <#how-to-contribute>`_
-* `Inclusion Criteria <#inclusion-criteria>`_
+* `API Cheatsheet & Reference <#api-cheatsheet--reference>`__
+* `Benchmarks <#benchmarks>`__
+* `Implemented Algorithms <#implemented-algorithms>`__ (Tabular, Time Series, Graph, Embedding)
+* `Additional Topics <#additional-topics>`__ (Model Save/Load, SUOD, Thresholding)
+* `Quick Start for Outlier Detection <#quick-start-for-outlier-detection>`__
+* `How to Contribute <#how-to-contribute>`__
+* `Inclusion Criteria <#inclusion-criteria>`__
 
 ----
 
@@ -280,7 +280,7 @@ For a broader perspective on anomaly detection, see our NeurIPS papers on `ADBen
 API Cheatsheet & Reference
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-The full API Reference is split by modality at `PyOD Documentation <https://pyod.readthedocs.io/en/latest/>`_: `Tabular <https://pyod.readthedocs.io/en/latest/pyod.models.tabular.html>`_, `Time Series <https://pyod.readthedocs.io/en/latest/pyod.models.timeseries.html>`_, `Graph <https://pyod.readthedocs.io/en/latest/pyod.models.graph.html>`_, `Embedding <https://pyod.readthedocs.io/en/latest/pyod.models.embedding.html>`_, `ADEngine <https://pyod.readthedocs.io/en/latest/pyod.ad_engine.html>`_, `Utilities <https://pyod.readthedocs.io/en/latest/pyod.utils.html>`_. Below is a quick cheatsheet for all detectors:
+The full API Reference is split by modality at `PyOD Documentation <https://pyod.readthedocs.io/en/latest/>`__: `Tabular <https://pyod.readthedocs.io/en/latest/pyod.models.tabular.html>`__, `Time Series <https://pyod.readthedocs.io/en/latest/pyod.models.timeseries.html>`__, `Graph <https://pyod.readthedocs.io/en/latest/pyod.models.graph.html>`__, `Embedding <https://pyod.readthedocs.io/en/latest/pyod.models.embedding.html>`__, `ADEngine <https://pyod.readthedocs.io/en/latest/pyod.ad_engine.html>`__, `Utilities <https://pyod.readthedocs.io/en/latest/pyod.utils.html>`__. Below is a quick cheatsheet for all detectors:
 
 * **fit(X)**: Fit the detector. The parameter y is ignored in unsupervised methods.
 * **decision_function(X)**: Predict raw anomaly scores for X using the fitted detector.
@@ -301,19 +301,19 @@ The full API Reference is split by modality at `PyOD Documentation <https://pyod
 Benchmarks
 ^^^^^^^^^^
 
-* `ADBench <https://github.com/Minqi824/ADBench>`_ [#Han2022ADBench]_: 30 algorithms on 57 tabular datasets. See `comparison <https://github.com/yzhao062/pyod/blob/master/examples/compare_all_models.py>`_.
-* `NLP-ADBench <https://github.com/USC-FORTIS/NLP-ADBench>`_: 19 methods on 8 text datasets. Two-step (embedding + detector) beats end-to-end.
-* `TSB-AD <https://github.com/TheDatumOrg/TSB-AD>`_ [#Liu2024TSB]_: 40 algorithms on 1070 time series datasets (NeurIPS 2024).
-* `BOND <https://arxiv.org/abs/2206.10071>`_ [#Liu2022BOND]_: 14 graph anomaly detection algorithms on 14 datasets (NeurIPS 2022).
+* `ADBench <https://github.com/Minqi824/ADBench>`__ [#Han2022ADBench]_: 30 algorithms on 57 tabular datasets. See `comparison <https://github.com/yzhao062/pyod/blob/master/examples/compare_all_models.py>`__.
+* `NLP-ADBench <https://github.com/USC-FORTIS/NLP-ADBench>`__: 19 methods on 8 text datasets. Two-step (embedding + detector) beats end-to-end.
+* `TSB-AD <https://github.com/TheDatumOrg/TSB-AD>`__ [#Liu2024TSB]_: 40 algorithms on 1070 time series datasets (NeurIPS 2024).
+* `BOND <https://arxiv.org/abs/2206.10071>`__ [#Liu2022BOND]_: 14 graph anomaly detection algorithms on 14 datasets (NeurIPS 2022).
 
 ----
 
 Additional Topics
 ^^^^^^^^^^^^^^^^^
 
-* `Model Save & Load <https://pyod.readthedocs.io/en/latest/model_persistence.html>`_: Use joblib or pickle for saving and loading PyOD models. See `example <https://github.com/yzhao062/pyod/blob/master/examples/save_load_model_example.py>`_.
-* `Fast Train with SUOD <https://pyod.readthedocs.io/en/latest/fast_train.html>`_: Accelerate training and prediction with the SUOD framework [#Zhao2021SUOD]_. See `example <https://github.com/yzhao062/pyod/blob/master/examples/suod_example.py>`_.
-* `Thresholding Outlier Scores <https://pyod.readthedocs.io/en/latest/thresholding.html>`_: Data-driven approaches for setting contamination levels via `PyThresh <https://github.com/KulikDM/pythresh>`_.
+* `Model Save & Load <https://pyod.readthedocs.io/en/latest/model_persistence.html>`__: Use joblib or pickle for saving and loading PyOD models. See `example <https://github.com/yzhao062/pyod/blob/master/examples/save_load_model_example.py>`__.
+* `Fast Train with SUOD <https://pyod.readthedocs.io/en/latest/fast_train.html>`__: Accelerate training and prediction with the SUOD framework [#Zhao2021SUOD]_. See `example <https://github.com/yzhao062/pyod/blob/master/examples/suod_example.py>`__.
+* `Thresholding Outlier Scores <https://pyod.readthedocs.io/en/latest/thresholding.html>`__: Data-driven approaches for setting contamination levels via `PyThresh <https://github.com/KulikDM/pythresh>`__.
 
 ----
 
@@ -337,212 +337,212 @@ PyOD is organized into two functional groups: **(i) Detection Algorithms**, with
      - Ref
    * - Probabilistic
      - ECOD
-     - Unsupervised Outlier Detection Using Empirical Cumulative Distribution Functions (`example <https://github.com/yzhao062/pyod/blob/development/examples/ecod_example.py>`_)
+     - Unsupervised Outlier Detection Using Empirical Cumulative Distribution Functions (`example <https://github.com/yzhao062/pyod/blob/development/examples/ecod_example.py>`__)
      - 2022
      - [#Li2021ECOD]_
    * - Probabilistic
      - ABOD
-     - Angle-Based Outlier Detection (`example <https://github.com/yzhao062/pyod/blob/development/examples/abod_example.py>`_)
+     - Angle-Based Outlier Detection (`example <https://github.com/yzhao062/pyod/blob/development/examples/abod_example.py>`__)
      - 2008
      - [#Kriegel2008Angle]_
    * - Probabilistic
      - FastABOD
-     - Fast Angle-Based Outlier Detection using approximation (`example <https://github.com/yzhao062/pyod/blob/development/examples/abod_example.py>`_)
+     - Fast Angle-Based Outlier Detection using approximation (`example <https://github.com/yzhao062/pyod/blob/development/examples/abod_example.py>`__)
      - 2008
      - [#Kriegel2008Angle]_
    * - Probabilistic
      - COPOD
-     - COPOD: Copula-Based Outlier Detection (`example <https://github.com/yzhao062/pyod/blob/development/examples/copod_example.py>`_)
+     - COPOD: Copula-Based Outlier Detection (`example <https://github.com/yzhao062/pyod/blob/development/examples/copod_example.py>`__)
      - 2020
      - [#Li2020COPOD]_
    * - Probabilistic
      - MAD
-     - Median Absolute Deviation (MAD) (`example <https://github.com/yzhao062/pyod/blob/development/examples/mad_example.py>`_)
+     - Median Absolute Deviation (MAD) (`example <https://github.com/yzhao062/pyod/blob/development/examples/mad_example.py>`__)
      - 1993
      - [#Iglewicz1993How]_
    * - Probabilistic
      - SOS
-     - Stochastic Outlier Selection (`example <https://github.com/yzhao062/pyod/blob/development/examples/sos_example.py>`_)
+     - Stochastic Outlier Selection (`example <https://github.com/yzhao062/pyod/blob/development/examples/sos_example.py>`__)
      - 2012
      - [#Janssens2012Stochastic]_
    * - Probabilistic
      - QMCD
-     - Quasi-Monte Carlo Discrepancy outlier detection (`example <https://github.com/yzhao062/pyod/blob/development/examples/qmcd_example.py>`_)
+     - Quasi-Monte Carlo Discrepancy outlier detection (`example <https://github.com/yzhao062/pyod/blob/development/examples/qmcd_example.py>`__)
      - 2001
      - [#Fang2001Wrap]_
    * - Probabilistic
      - KDE
-     - Outlier Detection with Kernel Density Functions (`example <https://github.com/yzhao062/pyod/blob/development/examples/kde_example.py>`_)
+     - Outlier Detection with Kernel Density Functions (`example <https://github.com/yzhao062/pyod/blob/development/examples/kde_example.py>`__)
      - 2007
      - [#Latecki2007Outlier]_
    * - Probabilistic
      - Sampling
-     - Rapid distance-based outlier detection via sampling (`example <https://github.com/yzhao062/pyod/blob/development/examples/sampling_example.py>`_)
+     - Rapid distance-based outlier detection via sampling (`example <https://github.com/yzhao062/pyod/blob/development/examples/sampling_example.py>`__)
      - 2013
      - [#Sugiyama2013Rapid]_
    * - Probabilistic
      - GMM
-     - Probabilistic Mixture Modeling for Outlier Analysis (`example <https://github.com/yzhao062/pyod/blob/development/examples/gmm_example.py>`_)
+     - Probabilistic Mixture Modeling for Outlier Analysis (`example <https://github.com/yzhao062/pyod/blob/development/examples/gmm_example.py>`__)
      -
      - [#Aggarwal2015Outlier]_ [Ch.2]
    * - Linear Model
      - PCA
-     - Principal Component Analysis (sum of weighted projected distances to eigenvector hyperplanes) (`example <https://github.com/yzhao062/pyod/blob/development/examples/pca_example.py>`_)
+     - Principal Component Analysis (sum of weighted projected distances to eigenvector hyperplanes) (`example <https://github.com/yzhao062/pyod/blob/development/examples/pca_example.py>`__)
      - 2003
      - [#Shyu2003A]_
    * - Linear Model
      - KPCA
-     - Kernel Principal Component Analysis (`example <https://github.com/yzhao062/pyod/blob/development/examples/kpca_example.py>`_)
+     - Kernel Principal Component Analysis (`example <https://github.com/yzhao062/pyod/blob/development/examples/kpca_example.py>`__)
      - 2007
      - [#Hoffmann2007Kernel]_
    * - Linear Model
      - MCD
-     - Minimum Covariance Determinant (Mahalanobis distances as outlier scores) (`example <https://github.com/yzhao062/pyod/blob/development/examples/mcd_example.py>`_)
+     - Minimum Covariance Determinant (Mahalanobis distances as outlier scores) (`example <https://github.com/yzhao062/pyod/blob/development/examples/mcd_example.py>`__)
      - 1999
      - [#Hardin2004Outlier]_ [#Rousseeuw1999A]_
    * - Linear Model
      - CD
-     - Cook's distance for outlier detection (`example <https://github.com/yzhao062/pyod/blob/development/examples/cd_example.py>`_)
+     - Cook's distance for outlier detection (`example <https://github.com/yzhao062/pyod/blob/development/examples/cd_example.py>`__)
      - 1977
      - [#Cook1977Detection]_
    * - Linear Model
      - OCSVM
-     - One-Class Support Vector Machines (`example <https://github.com/yzhao062/pyod/blob/development/examples/ocsvm_example.py>`_)
+     - One-Class Support Vector Machines (`example <https://github.com/yzhao062/pyod/blob/development/examples/ocsvm_example.py>`__)
      - 2001
      - [#Scholkopf2001Estimating]_
    * - Linear Model
      - LMDD
-     - Deviation-based Outlier Detection (LMDD) (`example <https://github.com/yzhao062/pyod/blob/development/examples/lmdd_example.py>`_)
+     - Deviation-based Outlier Detection (LMDD) (`example <https://github.com/yzhao062/pyod/blob/development/examples/lmdd_example.py>`__)
      - 1996
      - [#Arning1996A]_
    * - Proximity-Based
      - LOF
-     - Local Outlier Factor (`example <https://github.com/yzhao062/pyod/blob/development/examples/lof_example.py>`_)
+     - Local Outlier Factor (`example <https://github.com/yzhao062/pyod/blob/development/examples/lof_example.py>`__)
      - 2000
      - [#Breunig2000LOF]_
    * - Proximity-Based
      - COF
-     - Connectivity-Based Outlier Factor (`example <https://github.com/yzhao062/pyod/blob/development/examples/cof_example.py>`_)
+     - Connectivity-Based Outlier Factor (`example <https://github.com/yzhao062/pyod/blob/development/examples/cof_example.py>`__)
      - 2002
      - [#Tang2002Enhancing]_
    * - Proximity-Based
      - (Incr.) COF
-     - Memory Efficient Connectivity-Based Outlier Factor (slower, reduced storage) (`example <https://github.com/yzhao062/pyod/blob/development/examples/cof_example.py>`_)
+     - Memory Efficient Connectivity-Based Outlier Factor (slower, reduced storage) (`example <https://github.com/yzhao062/pyod/blob/development/examples/cof_example.py>`__)
      - 2002
      - [#Tang2002Enhancing]_
    * - Proximity-Based
      - CBLOF
-     - Clustering-Based Local Outlier Factor (`example <https://github.com/yzhao062/pyod/blob/development/examples/cblof_example.py>`_)
+     - Clustering-Based Local Outlier Factor (`example <https://github.com/yzhao062/pyod/blob/development/examples/cblof_example.py>`__)
      - 2003
      - [#He2003Discovering]_
    * - Proximity-Based
      - LOCI
-     - LOCI: Fast outlier detection via local correlation integral (`example <https://github.com/yzhao062/pyod/blob/development/examples/loci_example.py>`_)
+     - LOCI: Fast outlier detection via local correlation integral (`example <https://github.com/yzhao062/pyod/blob/development/examples/loci_example.py>`__)
      - 2003
      - [#Papadimitriou2003LOCI]_
    * - Proximity-Based
      - HBOS
-     - Histogram-based Outlier Score (`example <https://github.com/yzhao062/pyod/blob/development/examples/hbos_example.py>`_)
+     - Histogram-based Outlier Score (`example <https://github.com/yzhao062/pyod/blob/development/examples/hbos_example.py>`__)
      - 2012
      - [#Goldstein2012Histogram]_
    * - Proximity-Based
      - HDBSCAN
-     - Density-based clustering via hierarchical density estimates (`example <https://github.com/yzhao062/pyod/blob/development/examples/hdbscan_example.py>`_)
+     - Density-based clustering via hierarchical density estimates (`example <https://github.com/yzhao062/pyod/blob/development/examples/hdbscan_example.py>`__)
      - 2013
      - [#Campello2013Density]_
    * - Proximity-Based
      - kNN
-     - k Nearest Neighbors (distance to k-th neighbor as outlier score) (`example <https://github.com/yzhao062/pyod/blob/development/examples/knn_example.py>`_)
+     - k Nearest Neighbors (distance to k-th neighbor as outlier score) (`example <https://github.com/yzhao062/pyod/blob/development/examples/knn_example.py>`__)
      - 2000
      - [#Ramaswamy2000Efficient]_
    * - Proximity-Based
      - AvgKNN
-     - Average kNN (average distance to k neighbors as outlier score) (`example <https://github.com/yzhao062/pyod/blob/development/examples/knn_example.py>`_)
+     - Average kNN (average distance to k neighbors as outlier score) (`example <https://github.com/yzhao062/pyod/blob/development/examples/knn_example.py>`__)
      - 2002
      - [#Angiulli2002Fast]_
    * - Proximity-Based
      - MedKNN
-     - Median kNN (median distance to k neighbors as outlier score) (`example <https://github.com/yzhao062/pyod/blob/development/examples/knn_example.py>`_)
+     - Median kNN (median distance to k neighbors as outlier score) (`example <https://github.com/yzhao062/pyod/blob/development/examples/knn_example.py>`__)
      - 2002
      - [#Angiulli2002Fast]_
    * - Proximity-Based
      - SOD
-     - Subspace Outlier Detection (`example <https://github.com/yzhao062/pyod/blob/development/examples/sod_example.py>`_)
+     - Subspace Outlier Detection (`example <https://github.com/yzhao062/pyod/blob/development/examples/sod_example.py>`__)
      - 2009
      - [#Kriegel2009Outlier]_
    * - Proximity-Based
      - ROD
-     - Rotation-based Outlier Detection (`example <https://github.com/yzhao062/pyod/blob/development/examples/rod_example.py>`_)
+     - Rotation-based Outlier Detection (`example <https://github.com/yzhao062/pyod/blob/development/examples/rod_example.py>`__)
      - 2020
      - [#Almardeny2020A]_
    * - Outlier Ensembles
      - IForest
-     - Isolation Forest (`example <https://github.com/yzhao062/pyod/blob/development/examples/iforest_example.py>`_)
+     - Isolation Forest (`example <https://github.com/yzhao062/pyod/blob/development/examples/iforest_example.py>`__)
      - 2008
      - [#Liu2008Isolation]_
    * - Outlier Ensembles
      - INNE
-     - Isolation-based Anomaly Detection via Nearest-Neighbor Ensembles (`example <https://github.com/yzhao062/pyod/blob/development/examples/inne_example.py>`_)
+     - Isolation-based Anomaly Detection via Nearest-Neighbor Ensembles (`example <https://github.com/yzhao062/pyod/blob/development/examples/inne_example.py>`__)
      - 2018
      - [#Bandaragoda2018Isolation]_
    * - Outlier Ensembles
      - DIF
-     - Deep Isolation Forest for Anomaly Detection (`example <https://github.com/yzhao062/pyod/blob/development/examples/dif_example.py>`_)
+     - Deep Isolation Forest for Anomaly Detection (`example <https://github.com/yzhao062/pyod/blob/development/examples/dif_example.py>`__)
      - 2023
      - [#Xu2023Deep]_
    * - Outlier Ensembles
      - FB
-     - Feature Bagging (`example <https://github.com/yzhao062/pyod/blob/development/examples/feature_bagging_example.py>`_)
+     - Feature Bagging (`example <https://github.com/yzhao062/pyod/blob/development/examples/feature_bagging_example.py>`__)
      - 2005
      - [#Lazarevic2005Feature]_
    * - Outlier Ensembles
      - LSCP
-     - LSCP: Locally Selective Combination of Parallel Outlier Ensembles (`example <https://github.com/yzhao062/pyod/blob/development/examples/lscp_example.py>`_)
+     - LSCP: Locally Selective Combination of Parallel Outlier Ensembles (`example <https://github.com/yzhao062/pyod/blob/development/examples/lscp_example.py>`__)
      - 2019
      - [#Zhao2019LSCP]_
    * - Outlier Ensembles
      - XGBOD
-     - Extreme Boosting Based Outlier Detection **(Supervised)** (`example <https://github.com/yzhao062/pyod/blob/development/examples/xgbod_example.py>`_)
+     - Extreme Boosting Based Outlier Detection **(Supervised)** (`example <https://github.com/yzhao062/pyod/blob/development/examples/xgbod_example.py>`__)
      - 2018
      - [#Zhao2018XGBOD]_
    * - Outlier Ensembles
      - LODA
-     - Lightweight On-line Detector of Anomalies (`example <https://github.com/yzhao062/pyod/blob/development/examples/loda_example.py>`_)
+     - Lightweight On-line Detector of Anomalies (`example <https://github.com/yzhao062/pyod/blob/development/examples/loda_example.py>`__)
      - 2016
      - [#Pevny2016Loda]_
    * - Outlier Ensembles
      - SUOD
-     - SUOD: Accelerating Large-scale Unsupervised Heterogeneous OD **(Acceleration)** (`example <https://github.com/yzhao062/pyod/blob/development/examples/suod_example.py>`_)
+     - SUOD: Accelerating Large-scale Unsupervised Heterogeneous OD **(Acceleration)** (`example <https://github.com/yzhao062/pyod/blob/development/examples/suod_example.py>`__)
      - 2021
      - [#Zhao2021SUOD]_
    * - Neural Networks
      - AutoEncoder
-     - Fully connected AutoEncoder (reconstruction error as outlier score) (`example <https://github.com/yzhao062/pyod/blob/development/examples/auto_encoder_example.py>`_)
+     - Fully connected AutoEncoder (reconstruction error as outlier score) (`example <https://github.com/yzhao062/pyod/blob/development/examples/auto_encoder_example.py>`__)
      -
      - [#Aggarwal2015Outlier]_ [Ch.3]
    * - Neural Networks
      - VAE
-     - Variational AutoEncoder (reconstruction error as outlier score) (`example <https://github.com/yzhao062/pyod/blob/development/examples/vae_example.py>`_)
+     - Variational AutoEncoder (reconstruction error as outlier score) (`example <https://github.com/yzhao062/pyod/blob/development/examples/vae_example.py>`__)
      - 2013
      - [#Kingma2013Auto]_
    * - Neural Networks
      - Beta-VAE
-     - Variational AutoEncoder with customized loss (gamma and capacity) (`example <https://github.com/yzhao062/pyod/blob/development/examples/vae_example.py>`_)
+     - Variational AutoEncoder with customized loss (gamma and capacity) (`example <https://github.com/yzhao062/pyod/blob/development/examples/vae_example.py>`__)
      - 2018
      - [#Burgess2018Understanding]_
    * - Neural Networks
      - SO_GAAL
-     - Single-Objective Generative Adversarial Active Learning (`example <https://github.com/yzhao062/pyod/blob/development/examples/so_gaal_example.py>`_)
+     - Single-Objective Generative Adversarial Active Learning (`example <https://github.com/yzhao062/pyod/blob/development/examples/so_gaal_example.py>`__)
      - 2019
      - [#Liu2019Generative]_
    * - Neural Networks
      - MO_GAAL
-     - Multiple-Objective Generative Adversarial Active Learning (`example <https://github.com/yzhao062/pyod/blob/development/examples/mo_gaal_example.py>`_)
+     - Multiple-Objective Generative Adversarial Active Learning (`example <https://github.com/yzhao062/pyod/blob/development/examples/mo_gaal_example.py>`__)
      - 2019
      - [#Liu2019Generative]_
    * - Neural Networks
      - DeepSVDD
-     - Deep One-Class Classification (`example <https://github.com/yzhao062/pyod/blob/development/examples/deepsvdd_example.py>`_)
+     - Deep One-Class Classification (`example <https://github.com/yzhao062/pyod/blob/development/examples/deepsvdd_example.py>`__)
      - 2018
      - [#Ruff2018Deep]_
    * - Neural Networks
@@ -552,37 +552,37 @@ PyOD is organized into two functional groups: **(i) Detection Algorithms**, with
      - [#Schlegl2017Unsupervised]_
    * - Neural Networks
      - ALAD
-     - Adversarially learned anomaly detection (`example <https://github.com/yzhao062/pyod/blob/development/examples/alad_example.py>`_)
+     - Adversarially learned anomaly detection (`example <https://github.com/yzhao062/pyod/blob/development/examples/alad_example.py>`__)
      - 2018
      - [#Zenati2018Adversarially]_
    * - Neural Networks
      - AE1SVM
-     - Autoencoder-based One-class Support Vector Machine (`example <https://github.com/yzhao062/pyod/blob/development/examples/ae1svm_example.py>`_)
+     - Autoencoder-based One-class Support Vector Machine (`example <https://github.com/yzhao062/pyod/blob/development/examples/ae1svm_example.py>`__)
      - 2019
      - [#Nguyen2019scalable]_
    * - Neural Networks
      - DevNet
-     - Deep Anomaly Detection with Deviation Networks (`example <https://github.com/yzhao062/pyod/blob/development/examples/devnet_example.py>`_)
+     - Deep Anomaly Detection with Deviation Networks (`example <https://github.com/yzhao062/pyod/blob/development/examples/devnet_example.py>`__)
      - 2019
      - [#Pang2019Deep]_
    * - Graph-based
      - R-Graph
-     - Outlier detection by R-graph (`example <https://github.com/yzhao062/pyod/blob/development/examples/rgraph_example.py>`_)
+     - Outlier detection by R-graph (`example <https://github.com/yzhao062/pyod/blob/development/examples/rgraph_example.py>`__)
      - 2017
      - [#You2017Provable]_
    * - Graph-based
      - LUNAR
-     - LUNAR: Unifying Local OD Methods via Graph Neural Networks (`example <https://github.com/yzhao062/pyod/blob/development/examples/lunar_example.py>`_)
+     - LUNAR: Unifying Local OD Methods via Graph Neural Networks (`example <https://github.com/yzhao062/pyod/blob/development/examples/lunar_example.py>`__)
      - 2022
      - [#Goodge2022Lunar]_
    * - Embedding-based
      - EmbeddingOD
-     - Multi-modal anomaly detection via foundation model embeddings, text and image (`example <https://github.com/yzhao062/pyod/blob/development/examples/embedding_od_example.py>`_)
+     - Multi-modal anomaly detection via foundation model embeddings, text and image (`example <https://github.com/yzhao062/pyod/blob/development/examples/embedding_od_example.py>`__)
      - 2025
      - [#Li2024NLPADBench]_
 
 
-Ensemble methods (IForest, INNE, DIF, FB, LSCP, LODA, SUOD, XGBOD) are included in the table above. Score combination functions (average, maximization, AOM, MOA, median, majority vote) are in ``pyod.models.combination``. See `API docs <https://pyod.readthedocs.io/en/latest/pyod.models.tabular.html>`_ for details.
+Ensemble methods (IForest, INNE, DIF, FB, LSCP, LODA, SUOD, XGBOD) are included in the table above. Score combination functions (average, maximization, AOM, MOA, median, majority vote) are in ``pyod.models.combination``. See `API docs <https://pyod.readthedocs.io/en/latest/pyod.models.tabular.html>`__ for details.
 
 
 **(i-b) Time Series Anomaly Detection** :
@@ -600,7 +600,7 @@ All time series detectors use the same ``fit``/``predict``/``decision_function``
     clf.fit(X_train)                               # shape (n_timestamps,) or (n_timestamps, n_channels)
     scores = clf.decision_scores_                  # per-timestamp anomaly scores
 
-Algorithm rankings from `TSB-AD benchmark <https://github.com/TheDatumOrg/TSB-AD>`_ [#Liu2024TSB]_ (NeurIPS 2024, 1070 datasets):
+Algorithm rankings from `TSB-AD benchmark <https://github.com/TheDatumOrg/TSB-AD>`__ [#Liu2024TSB]_ (NeurIPS 2024, 1070 datasets):
 
 .. list-table::
    :widths: 15 18 50 5 12
@@ -613,27 +613,27 @@ Algorithm rankings from `TSB-AD benchmark <https://github.com/TheDatumOrg/TSB-AD
      - Ref
    * - Windowed Bridge
      - TimeSeriesOD
-     - Any PyOD detector on sliding windows (`example <https://github.com/yzhao062/pyod/blob/development/examples/ts_od_example.py>`_)
+     - Any PyOD detector on sliding windows (`example <https://github.com/yzhao062/pyod/blob/development/examples/ts_od_example.py>`__)
      - 2026
      -
    * - Subsequence
      - MatrixProfile
-     - Matrix Profile via STOMP, transductive (`example <https://github.com/yzhao062/pyod/blob/development/examples/ts_matrix_profile_example.py>`_)
+     - Matrix Profile via STOMP, transductive (`example <https://github.com/yzhao062/pyod/blob/development/examples/ts_matrix_profile_example.py>`__)
      - 2016
      - [#Yeh2016Matrix]_
    * - Frequency
      - SpectralResidual
-     - Spectral Residual: FFT-based saliency (`example <https://github.com/yzhao062/pyod/blob/development/examples/ts_spectral_residual_example.py>`_)
+     - Spectral Residual: FFT-based saliency (`example <https://github.com/yzhao062/pyod/blob/development/examples/ts_spectral_residual_example.py>`__)
      - 2019
      - [#Ren2019Time]_
    * - Clustering
      - KShape
-     - k-Shape clustering (#2 in TSB-AD) (`example <https://github.com/yzhao062/pyod/blob/development/examples/ts_kshape_example.py>`_)
+     - k-Shape clustering (#2 in TSB-AD) (`example <https://github.com/yzhao062/pyod/blob/development/examples/ts_kshape_example.py>`__)
      - 2015
      - [#Paparrizos2015KShape]_
    * - Streaming
      - SAND
-     - Streaming with drift adaptation, experimental (`example <https://github.com/yzhao062/pyod/blob/development/examples/ts_sand_example.py>`_)
+     - Streaming with drift adaptation, experimental (`example <https://github.com/yzhao062/pyod/blob/development/examples/ts_sand_example.py>`__)
      - 2021
      - [#Boniol2021SAND]_
    * - Deep Learning
@@ -661,7 +661,7 @@ All graph detectors are **transductive** in v1: use ``decision_scores_`` and ``l
     clf.fit(data)                                  # PyG Data object
     scores = clf.decision_scores_                  # per-node anomaly scores
 
-Algorithm rankings from `BOND benchmark <https://arxiv.org/abs/2206.10071>`_ [#Liu2022BOND]_ (NeurIPS 2022, 14 datasets):
+Algorithm rankings from `BOND benchmark <https://arxiv.org/abs/2206.10071>`__ [#Liu2022BOND]_ (NeurIPS 2022, 14 datasets):
 
 .. list-table::
    :widths: 18 18 45 5 14
@@ -674,42 +674,42 @@ Algorithm rankings from `BOND benchmark <https://arxiv.org/abs/2206.10071>`_ [#L
      - Ref
    * - GCN Autoencoder
      - DOMINANT
-     - GCN AE, structure + attribute reconstruction (#1 BOND deep) (`dominant example <https://github.com/yzhao062/pyod/blob/development/examples/pyg_dominant_example.py>`_)
+     - GCN AE, structure + attribute reconstruction (#1 BOND deep) (`dominant example <https://github.com/yzhao062/pyod/blob/development/examples/pyg_dominant_example.py>`__)
      - 2019
      - [#Ding2019DOMINANT]_
    * - Contrastive
      - CoLA
-     - Contrastive self-supervised, local neighbor context (#2 BOND deep) (`cola example <https://github.com/yzhao062/pyod/blob/development/examples/pyg_cola_example.py>`_)
+     - Contrastive self-supervised, local neighbor context (#2 BOND deep) (`cola example <https://github.com/yzhao062/pyod/blob/development/examples/pyg_cola_example.py>`__)
      - 2022
      - [#Liu2022CoLA]_
    * - Contrastive+AE
      - CONAD
-     - Contrastive with anomalous-view injection + dual reconstruction (`conad example <https://github.com/yzhao062/pyod/blob/development/examples/pyg_conad_example.py>`_)
+     - Contrastive with anomalous-view injection + dual reconstruction (`conad example <https://github.com/yzhao062/pyod/blob/development/examples/pyg_conad_example.py>`__)
      - 2022
      - [#Xu2022CONAD]_
    * - Attention AE
      - AnomalyDAE
-     - GAT structure encoder + MLP attribute encoder (`anomalydae example <https://github.com/yzhao062/pyod/blob/development/examples/pyg_anomalydae_example.py>`_)
+     - GAT structure encoder + MLP attribute encoder (`anomalydae example <https://github.com/yzhao062/pyod/blob/development/examples/pyg_anomalydae_example.py>`__)
      - 2020
      - [#Fan2020AnomalyDAE]_
    * - Motif AE
      - GUIDE
-     - Dual GCN AE on original + triangle-motif adjacency (`guide example <https://github.com/yzhao062/pyod/blob/development/examples/pyg_guide_example.py>`_)
+     - Dual GCN AE on original + triangle-motif adjacency (`guide example <https://github.com/yzhao062/pyod/blob/development/examples/pyg_guide_example.py>`__)
      - 2021
      - [#Yuan2021GUIDE]_
    * - Matrix Factor.
      - Radar
-     - Residual analysis via matrix factorization (`radar example <https://github.com/yzhao062/pyod/blob/development/examples/pyg_radar_example.py>`_)
+     - Residual analysis via matrix factorization (`radar example <https://github.com/yzhao062/pyod/blob/development/examples/pyg_radar_example.py>`__)
      - 2017
      - [#Li2017Radar]_
    * - Matrix Factor.
      - ANOMALOUS
-     - Joint MF with Laplacian regularization (`anomalous example <https://github.com/yzhao062/pyod/blob/development/examples/pyg_anomalous_example.py>`_)
+     - Joint MF with Laplacian regularization (`anomalous example <https://github.com/yzhao062/pyod/blob/development/examples/pyg_anomalous_example.py>`__)
      - 2018
      - [#Peng2018ANOMALOUS]_
    * - Structural
      - SCAN
-     - Structural clustering, no features needed (`scan example <https://github.com/yzhao062/pyod/blob/development/examples/pyg_scan_example.py>`_)
+     - Structural clustering, no features needed (`scan example <https://github.com/yzhao062/pyod/blob/development/examples/pyg_scan_example.py>`__)
      - 2007
      - [#Xu2007SCAN]_
 
@@ -738,16 +738,16 @@ Quick Start for Outlier Detection
 
 PyOD has been well acknowledged by the machine learning community with a few featured posts and tutorials.
 
-**Analytics Vidhya**: `An Awesome Tutorial to Learn Outlier Detection in Python using PyOD Library <https://www.analyticsvidhya.com/blog/2019/02/outlier-detection-python-pyod/>`_
+**Analytics Vidhya**: `An Awesome Tutorial to Learn Outlier Detection in Python using PyOD Library <https://www.analyticsvidhya.com/blog/2019/02/outlier-detection-python-pyod/>`__
 
-**KDnuggets**: `Intuitive Visualization of Outlier Detection Methods <https://www.kdnuggets.com/2019/02/outlier-detection-methods-cheat-sheet.html>`_, `An Overview of Outlier Detection Methods from PyOD <https://www.kdnuggets.com/2019/06/overview-outlier-detection-methods-pyod.html>`_
+**KDnuggets**: `Intuitive Visualization of Outlier Detection Methods <https://www.kdnuggets.com/2019/02/outlier-detection-methods-cheat-sheet.html>`__, `An Overview of Outlier Detection Methods from PyOD <https://www.kdnuggets.com/2019/06/overview-outlier-detection-methods-pyod.html>`__
 
-**Towards Data Science**: `Anomaly Detection for Dummies <https://towardsdatascience.com/anomaly-detection-for-dummies-15f148e559c1>`_
+**Towards Data Science**: `Anomaly Detection for Dummies <https://towardsdatascience.com/anomaly-detection-for-dummies-15f148e559c1>`__
 
-`"examples/knn_example.py" <https://github.com/yzhao062/pyod/blob/master/examples/knn_example.py>`_
+`"examples/knn_example.py" <https://github.com/yzhao062/pyod/blob/master/examples/knn_example.py>`__
 demonstrates the basic API of using kNN detector. **It is noted that the API across all other algorithms are consistent/similar**.
 
-More detailed instructions for running examples can be found in `examples directory <https://github.com/yzhao062/pyod/blob/master/examples>`_.
+More detailed instructions for running examples can be found in `examples directory <https://github.com/yzhao062/pyod/blob/master/examples>`__.
 
 
 #. Initialize a kNN detector, fit the model, and make the prediction.