API Reference#

The following APIs are the key ones for using SUOD:

  • suod.models.base.SUOD.fit(): Fit estimator. y is optional for unsupervised methods.

  • suod.models.base.SUOD.approximate(): Use supervised models to approximate unsupervised base detectors. Fit should be invoked first.

  • suod.models.base.SUOD.predict(): Predict on a particular sample once the estimator is fitted.

  • suod.models.base.SUOD.predict_proba(): Predict the probability of a sample is an anomaly once the estimator is fitted.

  • suod.models.base.SUOD.decision_function(): Predict raw anomaly scores of X using the fitted detectors.

  • suod.models.base.SUOD.get_params(): Get the parameters of the model.

  • suod.models.base.SUOD.set_params(): Set the parameters of the model.

  • Each base estimator can be accessed by calling clf[i] where i is the estimator index.


All Models#