/ docs / pyod.ad_engine.rst
pyod.ad_engine.rst
 1  ADEngine
 2  ========
 3  
 4  :class:`pyod.utils.ad_engine.ADEngine` is PyOD's intelligent anomaly detection engine. It provides three layers of capability:
 5  
 6  * **Knowledge queries** -- list detectors, explain detectors, get benchmarks
 7  * **Detection lifecycle** -- profile, plan, run, analyze, explain, iterate, report
 8  * **Session workflow** (V3) -- start → plan → run → analyze → iterate → report with typed state
 9  
10  See :doc:`examples/adengine` for usage examples and :doc:`examples/agentic` for the agentic workflow.
11  
12  pyod.utils.ad\_engine module
13  ----------------------------
14  
15  .. automodule:: pyod.utils.ad_engine
16      :members:
17      :exclude-members: get_params, set_params
18      :undoc-members:
19      :show-inheritance:
20  
21  pyod.utils.investigation module
22  --------------------------------
23  
24  .. automodule:: pyod.utils.investigation
25      :members:
26      :exclude-members: get_params, set_params
27      :undoc-members:
28      :show-inheritance:
29  
30  pyod.utils.knowledge module
31  ----------------------------
32  
33  .. automodule:: pyod.utils.knowledge
34      :members:
35      :exclude-members: get_params, set_params
36      :undoc-members:
37      :show-inheritance: