/ docs / pyod.models.tabular.rst
pyod.models.tabular.rst
  1  Tabular Detectors
  2  ==================
  3  
  4  PyOD ships 40+ detectors for tabular data, spanning probabilistic, linear, proximity, ensemble, and deep learning approaches. All inherit from :class:`pyod.models.base.BaseDetector` and use the same ``fit``/``predict``/``decision_function`` API.
  5  
  6  See :doc:`examples/tabular` for usage examples and :doc:`api_cc` for the shared API reference.
  7  
  8  pyod.models.base module
  9  -----------------------
 10  
 11  .. automodule:: pyod.models.base
 12      :members:
 13      :exclude-members: get_params, set_params
 14      :undoc-members:
 15      :show-inheritance:
 16  
 17  
 18  pyod.models.abod module
 19  -----------------------
 20  
 21  .. automodule:: pyod.models.abod
 22      :members:
 23      :exclude-members: get_params, set_params
 24      :undoc-members:
 25      :show-inheritance:
 26  
 27  
 28  pyod.models.ae1svm module
 29  -------------------------
 30  
 31  .. automodule:: pyod.models.ae1svm
 32      :members:
 33      :exclude-members: get_params, set_params, RandomFourierFeatures, InnerAE1SVM, _train_autoencoder
 34      :undoc-members:
 35      :show-inheritance:
 36  
 37  
 38  pyod.models.alad module
 39  -----------------------
 40  
 41  .. automodule:: pyod.models.alad
 42      :members:
 43      :exclude-members: get_params, set_params, train_step, train_more, get_outlier_scores
 44      :undoc-members:
 45      :show-inheritance:
 46  
 47  
 48  pyod.models.anogan module
 49  -------------------------
 50  
 51  .. automodule:: pyod.models.anogan
 52      :members:
 53      :exclude-members: Discriminator, Generator, QueryModel
 54      :undoc-members:
 55      :show-inheritance:
 56  
 57  
 58  pyod.models.auto\_encoder module
 59  --------------------------------
 60  
 61  .. automodule:: pyod.models.auto_encoder
 62      :members:
 63      :exclude-members: get_params, set_params, decision_function_update, epoch_update, evaluating_prepare, evaluating_forward, AutoEncoderModel, load
 64      :undoc-members:
 65      :show-inheritance:
 66  
 67  
 68  pyod.models.auto\_encoder\_torch module
 69  ---------------------------------------
 70  
 71  .. automodule:: pyod.models.auto_encoder_torch
 72      :members:
 73      :exclude-members: get_params, set_params, InnerAutoencoder
 74      :exclude-members:
 75      :show-inheritance:
 76  
 77  
 78  pyod.models.cblof module
 79  ------------------------
 80  
 81  .. automodule:: pyod.models.cblof
 82      :members:
 83      :exclude-members: get_params, set_params,
 84      :undoc-members:
 85      :show-inheritance:
 86  
 87  
 88  pyod.models.cd module
 89  ---------------------
 90  
 91  .. automodule:: pyod.models.cd
 92      :members:
 93      :exclude-members: get_params, set_params,
 94      :undoc-members:
 95      :show-inheritance:
 96  
 97  
 98  pyod.models.cof module
 99  ----------------------
100  
101  .. automodule:: pyod.models.cof
102      :members:
103      :exclude-members: get_params, set_params,
104      :undoc-members:
105      :show-inheritance:
106  
107  
108  pyod.models.combination module
109  ------------------------------
110  
111  .. automodule:: pyod.models.combination
112      :members:
113      :exclude-members: get_params, set_params,
114      :undoc-members:
115      :show-inheritance:
116  
117  
118  pyod.models.copod module
119  ------------------------
120  
121  .. automodule:: pyod.models.copod
122      :members:
123      :exclude-members:
124      :undoc-members:
125      :show-inheritance:
126  
127  
128  pyod.models.deep\_svdd module
129  -----------------------------
130  
131  .. automodule:: pyod.models.deep_svdd
132      :members:
133      :exclude-members: InnerDeepSVDD
134      :undoc-members:
135      :show-inheritance:
136  
137  
138  pyod.models.devnet module
139  -----------------------------
140  
141  .. automodule:: pyod.models.devnet
142      :members:
143      :exclude-members: DevNetD, DevNetS, DevNetLinear, deviation_loss, train_and_test, deviation_network, SupDataset, input_batch_generation_sup_sparse, load_model_weight_predict
144      :undoc-members:
145      :show-inheritance:
146  
147  
148  pyod.models.dif module
149  -----------------------------
150  
151  .. automodule:: pyod.models.dif
152      :members:
153      :exclude-members: LinearBlock, MLPnet
154      :undoc-members:
155      :show-inheritance:
156  
157  
158  pyod.models.ecod module
159  ------------------------
160  
161  .. automodule:: pyod.models.ecod
162      :members:
163      :exclude-members: InnerDeepSVDD,
164      :undoc-members:
165      :show-inheritance:
166  
167  
168  pyod.models.feature\_bagging module
169  -----------------------------------
170  
171  .. automodule:: pyod.models.feature_bagging
172      :members:
173      :undoc-members:
174      :show-inheritance:
175  
176  
177  pyod.models.gmm module
178  ----------------------
179  
180  .. automodule:: pyod.models.gmm
181      :members:
182      :exclude-members: weights_, get_params, set_params, n_iter_, lower_bound_, means_, converged_, covariances_
183      :undoc-members:
184      :show-inheritance:
185  
186  
187  pyod.models.hbos module
188  -----------------------
189  
190  .. automodule:: pyod.models.hbos
191      :members:
192      :undoc-members:
193      :show-inheritance:
194  
195  
196  pyod.models.hdbscan module
197  --------------------------
198  
199  .. automodule:: pyod.models.hdbscan
200      :members:
201      :undoc-members:
202      :show-inheritance:
203  
204  
205  pyod.models.iforest module
206  --------------------------
207  
208  .. automodule:: pyod.models.iforest
209      :members:
210      :exclude-members: estimators_, estimators_features_, estimators_samples_, get_params, set_params,
211      :undoc-members:
212      :show-inheritance:
213  
214  
215  pyod.models.inne module
216  -----------------------
217  
218  .. automodule:: pyod.models.inne
219      :members:
220      :exclude-members:
221      :undoc-members:
222      :show-inheritance:
223  
224  
225  pyod.models.kde module
226  ----------------------
227  
228  .. automodule:: pyod.models.kde
229      :members:
230      :undoc-members:
231      :show-inheritance:
232  
233  
234  pyod.models.knn module
235  ----------------------
236  
237  .. automodule:: pyod.models.knn
238      :members:
239      :undoc-members:
240      :show-inheritance:
241  
242  
243  pyod.models.kpca module
244  -----------------------
245  
246  .. automodule:: pyod.models.kpca
247      :members:
248      :exclude-members: PyODKernelPCA
249      :undoc-members:
250      :show-inheritance:
251  
252  
253  pyod.models.lmdd module
254  -----------------------
255  
256  .. automodule:: pyod.models.lmdd
257      :members:
258      :undoc-members:
259      :show-inheritance:
260  
261  
262  pyod.models.loci module
263  -----------------------
264  
265  .. automodule:: pyod.models.loci
266      :members:
267      :undoc-members:
268      :show-inheritance:
269  
270  
271  pyod.models.loda module
272  -----------------------
273  
274  .. automodule:: pyod.models.loda
275      :members:
276      :undoc-members:
277      :show-inheritance:
278  
279  
280  pyod.models.lof module
281  ----------------------
282  
283  .. automodule:: pyod.models.lof
284      :members:
285      :exclude-members: negative_outlier_factor_, n_neighbors_
286      :undoc-members:
287      :show-inheritance:
288  
289  
290  pyod.models.lscp module
291  -----------------------
292  
293  .. automodule:: pyod.models.lscp
294      :members:
295      :undoc-members:
296      :show-inheritance:
297  
298  
299  pyod.models.lunar module
300  ------------------------
301  
302  .. automodule:: pyod.models.lunar
303      :members:
304      :exclude-members: SCORE_MODEL, WEIGHT_MODEL
305      :show-inheritance:
306  
307  
308  pyod.models.mad module
309  ----------------------
310  
311  .. automodule:: pyod.models.mad
312      :members:
313      :exclude-members:
314      :undoc-members:
315      :show-inheritance:
316  
317  
318  pyod.models.mcd module
319  ----------------------
320  
321  .. automodule:: pyod.models.mcd
322      :members:
323      :exclude-members: raw_location_, raw_covariance_, raw_support_, location_, covariance_, precision_, support_
324      :undoc-members:
325      :show-inheritance:
326  
327  
328  pyod.models.mo\_gaal module
329  ---------------------------
330  
331  .. automodule:: pyod.models.mo_gaal
332      :members:
333      :undoc-members:
334      :show-inheritance:
335  
336  
337  pyod.models.ocsvm module
338  ------------------------
339  
340  .. automodule:: pyod.models.ocsvm
341      :members:
342      :exclude-members: coef_, dual_coef_, support_, support_vectors_, intercept_
343      :undoc-members:
344      :show-inheritance:
345  
346  
347  pyod.models.pca module
348  ----------------------
349  
350  .. automodule:: pyod.models.pca
351      :members:
352      :exclude-members: components_, explained_variance_ratio_, singular_values_, mean_
353      :undoc-members:
354      :show-inheritance:
355  
356  
357  pyod.models.qmcd module
358  -------------------------
359  
360  .. automodule:: pyod.models.qmcd
361      :members:
362      :undoc-members:
363      :show-inheritance:
364  
365  
366  pyod.models.rgraph module
367  -------------------------
368  
369  .. automodule:: pyod.models.rgraph
370      :members:
371      :undoc-members:
372      :show-inheritance:
373  
374  
375  pyod.models.rod module
376  ----------------------
377  
378  .. automodule:: pyod.models.rod
379      :members:
380      :exclude-members: angle, euclidean, geometric_median, mad, process_sub, rod_3D, rod_nD, scale_angles, sigmoid
381      :undoc-members:
382      :show-inheritance:
383  
384  
385  pyod.models.sampling module
386  ---------------------------
387  
388  .. automodule:: pyod.models.sampling
389      :members:
390      :undoc-members:
391      :show-inheritance:
392  
393  
394  pyod.models.so\_gaal module
395  ---------------------------
396  
397  .. automodule:: pyod.models.so_gaal
398      :members:
399      :exclude-members: Discriminator, Generator
400      :undoc-members:
401      :show-inheritance:
402  
403  
404  pyod.models.sod module
405  ----------------------
406  
407  .. automodule:: pyod.models.sod
408      :members:
409      :undoc-members:
410      :show-inheritance:
411  
412  
413  pyod.models.sos module
414  ----------------------
415  
416  .. automodule:: pyod.models.sos
417      :members:
418      :undoc-members:
419      :show-inheritance:
420  
421  
422  pyod.models.suod module
423  -----------------------
424  
425  .. automodule:: pyod.models.suod
426      :members:
427      :undoc-members:
428      :show-inheritance:
429  
430  
431  pyod.models.thresholds module
432  -----------------------------
433  
434  .. automodule:: pyod.models.thresholds
435      :members:
436      :undoc-members:
437      :show-inheritance:
438  
439  
440  pyod.models.vae module
441  ----------------------
442  
443  .. automodule:: pyod.models.vae
444      :members:
445      :exclude-members: VAEModel, vae_loss
446      :undoc-members:
447      :show-inheritance:
448  
449  
450  pyod.models.xgbod module
451  ------------------------
452  
453  .. automodule:: pyod.models.xgbod
454      :members:
455      :undoc-members:
456      :show-inheritance:
457  
458  
459  .. rubric:: References
460  
461  .. bibliography::
462     :cited:
463     :labelprefix: M