API Reference

• All Models
  • pyod.models.abod module
    • ABOD
      • ABOD.decision_function()
      • ABOD.fit()
      • ABOD.fit_predict()
      • ABOD.fit_predict_score()
      • ABOD.get_params()
      • ABOD.predict()
      • ABOD.predict_confidence()
      • ABOD.predict_proba()
      • ABOD.set_params()
  • pyod.models.alad module
    • ALAD
      • ALAD.decision_function()
      • ALAD.fit()
      • ALAD.fit_predict()
      • ALAD.fit_predict_score()
      • ALAD.get_outlier_scores()
      • ALAD.get_params()
      • ALAD.plot_learning_curves()
      • ALAD.predict()
      • ALAD.predict_confidence()
      • ALAD.predict_proba()
      • ALAD.set_params()
      • ALAD.train_more()
      • ALAD.train_step()
  • pyod.models.anogan module
    • AnoGAN
      • AnoGAN.decision_function()
      • AnoGAN.fit()
      • AnoGAN.fit_predict()
      • AnoGAN.fit_predict_score()
      • AnoGAN.fit_query()
      • AnoGAN.get_params()
      • AnoGAN.plot_learning_curves()
      • AnoGAN.predict()
      • AnoGAN.predict_confidence()
      • AnoGAN.predict_proba()
      • AnoGAN.set_params()
      • AnoGAN.train_step()
  • pyod.models.auto_encoder module
    • AutoEncoder
      • AutoEncoder.decision_function()
      • AutoEncoder.fit()
      • AutoEncoder.fit_predict()
      • AutoEncoder.fit_predict_score()
      • AutoEncoder.get_params()
      • AutoEncoder.predict()
      • AutoEncoder.predict_confidence()
      • AutoEncoder.predict_proba()
      • AutoEncoder.set_params()
  • pyod.models.auto_encoder_torch module
    • AutoEncoder
      • AutoEncoder.decision_function()
      • AutoEncoder.fit()
      • AutoEncoder.fit_predict()
      • AutoEncoder.fit_predict_score()
      • AutoEncoder.get_params()
      • AutoEncoder.predict()
      • AutoEncoder.predict_confidence()
      • AutoEncoder.predict_proba()
      • AutoEncoder.set_params()
    • InnerAutoencoder
      • InnerAutoencoder.add_module()
      • InnerAutoencoder.apply()
      • InnerAutoencoder.bfloat16()
      • InnerAutoencoder.buffers()
      • InnerAutoencoder.children()
      • InnerAutoencoder.compile()
      • InnerAutoencoder.cpu()
      • InnerAutoencoder.cuda()
      • InnerAutoencoder.double()
      • InnerAutoencoder.eval()
      • InnerAutoencoder.extra_repr()
      • InnerAutoencoder.float()
      • InnerAutoencoder.forward()
      • InnerAutoencoder.get_buffer()
      • InnerAutoencoder.get_extra_state()
      • InnerAutoencoder.get_parameter()
      • InnerAutoencoder.get_submodule()
      • InnerAutoencoder.half()
      • InnerAutoencoder.ipu()
      • InnerAutoencoder.load_state_dict()
      • InnerAutoencoder.modules()
      • InnerAutoencoder.named_buffers()
      • InnerAutoencoder.named_children()
      • InnerAutoencoder.named_modules()
      • InnerAutoencoder.named_parameters()
      • InnerAutoencoder.parameters()
      • InnerAutoencoder.register_backward_hook()
      • InnerAutoencoder.register_buffer()
      • InnerAutoencoder.register_forward_hook()
      • InnerAutoencoder.register_forward_pre_hook()
      • InnerAutoencoder.register_full_backward_hook()
      • InnerAutoencoder.register_full_backward_pre_hook()
      • InnerAutoencoder.register_load_state_dict_post_hook()
      • InnerAutoencoder.register_module()
      • InnerAutoencoder.register_parameter()
      • InnerAutoencoder.register_state_dict_pre_hook()
      • InnerAutoencoder.requires_grad_()
      • InnerAutoencoder.set_extra_state()
      • InnerAutoencoder.share_memory()
      • InnerAutoencoder.state_dict()
      • InnerAutoencoder.to()
      • InnerAutoencoder.to_empty()
      • InnerAutoencoder.train()
      • InnerAutoencoder.type()
      • InnerAutoencoder.xpu()
      • InnerAutoencoder.zero_grad()
    • PyODDataset
  • pyod.models.cblof module
    • CBLOF
      • CBLOF.decision_function()
      • CBLOF.fit()
      • CBLOF.fit_predict()
      • CBLOF.fit_predict_score()
      • CBLOF.get_params()
      • CBLOF.predict()
      • CBLOF.predict_confidence()
      • CBLOF.predict_proba()
      • CBLOF.set_params()
  • pyod.models.cof module
    • COF
      • COF.decision_function()
      • COF.fit()
      • COF.fit_predict()
      • COF.fit_predict_score()
      • COF.get_params()
      • COF.predict()
      • COF.predict_confidence()
      • COF.predict_proba()
      • COF.set_params()
  • pyod.models.combination module
    • aom()
    • average()
    • majority_vote()
    • maximization()
    • median()
    • moa()
  • pyod.models.cd module
    • CD
      • CD.decision_function()
      • CD.fit()
      • CD.fit_predict()
      • CD.fit_predict_score()
      • CD.get_params()
      • CD.predict()
      • CD.predict_confidence()
      • CD.predict_proba()
      • CD.set_params()
  • pyod.models.copod module
    • COPOD
      • COPOD.decision_function()
      • COPOD.explain_outlier()
      • COPOD.fit()
      • COPOD.fit_predict()
      • COPOD.fit_predict_score()
      • COPOD.get_params()
      • COPOD.predict()
      • COPOD.predict_confidence()
      • COPOD.predict_proba()
      • COPOD.set_params()
    • skew()
  • pyod.models.deep_svdd module
    • DeepSVDD
      • DeepSVDD.decision_function()
      • DeepSVDD.fit()
      • DeepSVDD.fit_predict()
      • DeepSVDD.fit_predict_score()
      • DeepSVDD.get_params()
      • DeepSVDD.predict()
      • DeepSVDD.predict_confidence()
      • DeepSVDD.predict_proba()
      • DeepSVDD.set_params()
  • pyod.models.dif module
    • DIF
      • DIF.decision_function()
      • DIF.fit()
      • DIF.fit_predict()
      • DIF.fit_predict_score()
      • DIF.get_params()
      • DIF.predict()
      • DIF.predict_confidence()
      • DIF.predict_proba()
      • DIF.set_params()
  • pyod.models.ecod module
    • ECOD
      • ECOD.decision_function()
      • ECOD.explain_outlier()
      • ECOD.fit()
      • ECOD.fit_predict()
      • ECOD.fit_predict_score()
      • ECOD.get_params()
      • ECOD.predict()
      • ECOD.predict_confidence()
      • ECOD.predict_proba()
      • ECOD.set_params()
    • skew()
  • pyod.models.feature_bagging module
    • FeatureBagging
      • FeatureBagging.decision_function()
      • FeatureBagging.fit()
      • FeatureBagging.fit_predict()
      • FeatureBagging.fit_predict_score()
      • FeatureBagging.get_params()
      • FeatureBagging.predict()
      • FeatureBagging.predict_confidence()
      • FeatureBagging.predict_proba()
      • FeatureBagging.set_params()
  • pyod.models.gmm module
    • GMM
      • GMM.converged_
      • GMM.covariances_
      • GMM.decision_function()
      • GMM.fit()
      • GMM.fit_predict()
      • GMM.fit_predict_score()
      • GMM.get_params()
      • GMM.lower_bound_
      • GMM.means_
      • GMM.n_iter_
      • GMM.precisions_
      • GMM.precisions_cholesky_
      • GMM.predict()
      • GMM.predict_confidence()
      • GMM.predict_proba()
      • GMM.set_params()
      • GMM.weights_
  • pyod.models.hbos module
    • HBOS
      • HBOS.decision_function()
      • HBOS.fit()
      • HBOS.fit_predict()
      • HBOS.fit_predict_score()
      • HBOS.get_params()
      • HBOS.predict()
      • HBOS.predict_confidence()
      • HBOS.predict_proba()
      • HBOS.set_params()
  • pyod.models.iforest module
    • IForest
      • IForest.decision_function()
      • IForest.estimators_
      • IForest.estimators_features_
      • IForest.estimators_samples_
      • IForest.feature_importances_
      • IForest.fit()
      • IForest.fit_predict()
      • IForest.fit_predict_score()
      • IForest.get_params()
      • IForest.max_samples_
      • IForest.n_features_in_
      • IForest.offset_
      • IForest.predict()
      • IForest.predict_confidence()
      • IForest.predict_proba()
      • IForest.set_params()
  • pyod.models.inne module
    • INNE
      • INNE.decision_function()
      • INNE.fit()
      • INNE.fit_predict()
      • INNE.fit_predict_score()
      • INNE.get_params()
      • INNE.predict()
      • INNE.predict_confidence()
      • INNE.predict_proba()
      • INNE.set_params()
  • pyod.models.kde module
    • KDE
      • KDE.decision_function()
      • KDE.fit()
      • KDE.fit_predict()
      • KDE.fit_predict_score()
      • KDE.get_params()
      • KDE.predict()
      • KDE.predict_confidence()
      • KDE.predict_proba()
      • KDE.set_params()
  • pyod.models.knn module
    • KNN
      • KNN.decision_function()
      • KNN.fit()
      • KNN.fit_predict()
      • KNN.fit_predict_score()
      • KNN.get_params()
      • KNN.predict()
      • KNN.predict_confidence()
      • KNN.predict_proba()
      • KNN.set_params()
  • pyod.models.kpca module
    • KPCA
      • KPCA.decision_function()
      • KPCA.fit()
      • KPCA.fit_predict()
      • KPCA.fit_predict_score()
      • KPCA.get_params()
      • KPCA.predict()
      • KPCA.predict_confidence()
      • KPCA.predict_proba()
      • KPCA.set_params()
    • PyODKernelPCA
      • PyODKernelPCA.fit()
      • PyODKernelPCA.fit_transform()
      • PyODKernelPCA.get_centerer
      • PyODKernelPCA.get_feature_names_out()
      • PyODKernelPCA.get_kernel
      • PyODKernelPCA.get_metadata_routing()
      • PyODKernelPCA.get_params()
      • PyODKernelPCA.inverse_transform()
      • PyODKernelPCA.set_output()
      • PyODKernelPCA.set_params()
      • PyODKernelPCA.transform()
  • pyod.models.lmdd module
    • LMDD
      • LMDD.decision_function()
      • LMDD.fit()
      • LMDD.fit_predict()
      • LMDD.fit_predict_score()
      • LMDD.get_params()
      • LMDD.predict()
      • LMDD.predict_confidence()
      • LMDD.predict_proba()
      • LMDD.set_params()
  • pyod.models.loda module
    • LODA
      • LODA.decision_function()
      • LODA.fit()
      • LODA.fit_predict()
      • LODA.fit_predict_score()
      • LODA.get_params()
      • LODA.predict()
      • LODA.predict_confidence()
      • LODA.predict_proba()
      • LODA.set_params()
  • pyod.models.lof module
    • LOF
      • LOF.decision_function()
      • LOF.fit()
      • LOF.fit_predict()
      • LOF.fit_predict_score()
      • LOF.get_params()
      • LOF.predict()
      • LOF.predict_confidence()
      • LOF.predict_proba()
      • LOF.set_params()
  • pyod.models.loci module
    • LOCI
      • LOCI.decision_function()
      • LOCI.fit()
      • LOCI.fit_predict()
      • LOCI.fit_predict_score()
      • LOCI.get_params()
      • LOCI.predict()
      • LOCI.predict_confidence()
      • LOCI.predict_proba()
      • LOCI.set_params()
  • pyod.models.lunar module
    • LUNAR
      • LUNAR.decision_function()
      • LUNAR.fit()
      • LUNAR.fit_predict()
      • LUNAR.fit_predict_score()
      • LUNAR.get_params()
      • LUNAR.predict()
      • LUNAR.predict_confidence()
      • LUNAR.predict_proba()
      • LUNAR.set_params()
  • pyod.models.lscp module
    • LSCP
      • LSCP.decision_function()
      • LSCP.fit()
      • LSCP.fit_predict()
      • LSCP.fit_predict_score()
      • LSCP.get_params()
      • LSCP.predict()
      • LSCP.predict_confidence()
      • LSCP.predict_proba()
      • LSCP.set_params()
  • pyod.models.mad module
    • MAD
      • MAD.decision_function()
      • MAD.fit()
      • MAD.fit_predict()
      • MAD.fit_predict_score()
      • MAD.get_params()
      • MAD.predict()
      • MAD.predict_confidence()
      • MAD.predict_proba()
      • MAD.set_params()
  • pyod.models.mcd module
    • MCD
      • MCD.decision_function()
      • MCD.fit()
      • MCD.fit_predict()
      • MCD.fit_predict_score()
      • MCD.get_params()
      • MCD.predict()
      • MCD.predict_confidence()
      • MCD.predict_proba()
      • MCD.set_params()
  • pyod.models.mo_gaal module
    • MO_GAAL
      • MO_GAAL.decision_function()
      • MO_GAAL.fit()
      • MO_GAAL.fit_predict()
      • MO_GAAL.fit_predict_score()
      • MO_GAAL.get_params()
      • MO_GAAL.predict()
      • MO_GAAL.predict_confidence()
      • MO_GAAL.predict_proba()
      • MO_GAAL.set_params()
  • pyod.models.ocsvm module
    • OCSVM
      • OCSVM.decision_function()
      • OCSVM.fit()
      • OCSVM.fit_predict()
      • OCSVM.fit_predict_score()
      • OCSVM.get_params()
      • OCSVM.predict()
      • OCSVM.predict_confidence()
      • OCSVM.predict_proba()
      • OCSVM.set_params()
  • pyod.models.pca module
    • PCA
      • PCA.decision_function()
      • PCA.explained_variance_
      • PCA.fit()
      • PCA.fit_predict()
      • PCA.fit_predict_score()
      • PCA.get_params()
      • PCA.noise_variance_
      • PCA.predict()
      • PCA.predict_confidence()
      • PCA.predict_proba()
      • PCA.set_params()
  • pyod.models.qmcd module
    • QMCD
      • QMCD.decision_function()
      • QMCD.fit()
      • QMCD.fit_predict()
      • QMCD.fit_predict_score()
      • QMCD.get_params()
      • QMCD.predict()
      • QMCD.predict_confidence()
      • QMCD.predict_proba()
      • QMCD.set_params()
  • pyod.models.rgraph module
    • RGraph
      • RGraph.active_support_elastic_net()
      • RGraph.decision_function()
      • RGraph.elastic_net_subspace_clustering()
      • RGraph.fit()
      • RGraph.fit_predict()
      • RGraph.fit_predict_score()
      • RGraph.get_params()
      • RGraph.predict()
      • RGraph.predict_confidence()
      • RGraph.predict_proba()
      • RGraph.set_params()
  • pyod.models.rod module
    • ROD
      • ROD.decision_function()
      • ROD.fit()
      • ROD.fit_predict()
      • ROD.fit_predict_score()
      • ROD.get_params()
      • ROD.predict()
      • ROD.predict_confidence()
      • ROD.predict_proba()
      • ROD.set_params()
    • angle()
    • euclidean()
    • geometric_median()
    • mad()
    • process_sub()
    • rod_3D()
    • rod_nD()
    • scale_angles()
    • sigmoid()
  • pyod.models.sampling module
    • Sampling
      • Sampling.decision_function()
      • Sampling.fit()
      • Sampling.fit_predict()
      • Sampling.fit_predict_score()
      • Sampling.get_params()
      • Sampling.predict()
      • Sampling.predict_confidence()
      • Sampling.predict_proba()
      • Sampling.set_params()
  • pyod.models.sod module
    • SOD
      • SOD.decision_function()
      • SOD.fit()
      • SOD.fit_predict()
      • SOD.fit_predict_score()
      • SOD.get_params()
      • SOD.predict()
      • SOD.predict_confidence()
      • SOD.predict_proba()
      • SOD.set_params()
  • pyod.models.so_gaal module
    • SO_GAAL
      • SO_GAAL.decision_function()
      • SO_GAAL.fit()
      • SO_GAAL.fit_predict()
      • SO_GAAL.fit_predict_score()
      • SO_GAAL.get_params()
      • SO_GAAL.predict()
      • SO_GAAL.predict_confidence()
      • SO_GAAL.predict_proba()
      • SO_GAAL.set_params()
  • pyod.models.sos module
    • SOS
      • SOS.decision_function()
      • SOS.fit()
      • SOS.fit_predict()
      • SOS.fit_predict_score()
      • SOS.get_params()
      • SOS.predict()
      • SOS.predict_confidence()
      • SOS.predict_proba()
      • SOS.set_params()
  • pyod.models.suod module
    • SUOD
      • SUOD.decision_function()
      • SUOD.fit()
      • SUOD.fit_predict()
      • SUOD.fit_predict_score()
      • SUOD.get_params()
      • SUOD.predict()
      • SUOD.predict_confidence()
      • SUOD.predict_proba()
      • SUOD.set_params()
  • pyod.models.thresholds module
    • AUCP()
    • BOOT()
    • CHAU()
    • CLF()
    • CLUST()
    • CPD()
    • DECOMP()
    • DSN()
    • EB()
    • FGD()
    • FILTER()
    • FWFM()
    • GESD()
    • HIST()
    • IQR()
    • KARCH()
    • MAD()
    • MCST()
    • META()
    • MOLL()
    • MTT()
    • OCSVM()
    • QMCD()
    • REGR()
    • VAE()
    • WIND()
    • YJ()
    • ZSCORE()
  • pyod.models.vae module
    • VAE
      • VAE.decision_function()
      • VAE.fit()
      • VAE.fit_predict()
      • VAE.fit_predict_score()
      • VAE.get_params()
      • VAE.predict()
      • VAE.predict_confidence()
      • VAE.predict_proba()
      • VAE.sampling()
      • VAE.set_params()
      • VAE.vae_loss()
  • pyod.models.xgbod module
    • XGBOD
      • XGBOD.decision_function()
      • XGBOD.fit()
      • XGBOD.fit_predict()
      • XGBOD.fit_predict_score()
      • XGBOD.get_params()
      • XGBOD.predict()
      • XGBOD.predict_confidence()
      • XGBOD.predict_proba()
      • XGBOD.set_params()
  • Module contents
• Utility Functions
  • pyod.utils.data module
    • check_consistent_shape()
    • evaluate_print()
    • generate_data()
    • generate_data_categorical()
    • generate_data_clusters()
    • get_outliers_inliers()
  • pyod.utils.example module
    • data_visualize()
    • visualize()
  • pyod.utils.stat_models module
    • column_ecdf()
    • ecdf_terminate_equals_inplace()
    • pairwise_distances_no_broadcast()
    • pearsonr_mat()
    • wpearsonr()
  • pyod.utils.utility module
    • argmaxn()
    • check_detector()
    • check_parameter()
    • generate_bagging_indices()
    • generate_indices()
    • get_diff_elements()
    • get_intersection()
    • get_label_n()
    • get_list_diff()
    • get_optimal_n_bins()
    • invert_order()
    • precision_n_scores()
    • score_to_label()
    • standardizer()

Module contents