IsolationForest#

class sklearn.ensemble.IsolationForest(*, n_estimators=100, max_samples='auto', contamination='auto', max_features=1.0, bootstrap=False, n_jobs=None, random_state=None, verbose=0, warm_start=False)[source]#

孤立森林算法。

使用孤立森林算法返回每个样本的异常分数。

孤立森林算法通过随机选择一个特征，然后在所选特征的最大值和最小值之间随机选择一个分割值来“隔离”观测值。

由于递归划分可以用树结构表示，因此隔离样本所需的分割次数等效于从根节点到终止节点的路径长度。

这种随机树的森林中，平均路径长度是正常程度的度量，也是我们的决策函数。

随机分区为异常值产生了明显更短的路径。因此，当随机树的森林共同为特定样本产生更短的路径长度时，它们极有可能为异常值。

更多信息请阅读 用户指南。

版本 0.18 中新增。

参数:
n_estimatorsint, 默认值=100

集成中基础估计器的数量。

max_samples“auto”, int 或 float, 默认值=”auto”

从 X 中抽取用于训练每个基础估计器的样本数。

  • 如果为整数，则抽取 max_samples 个样本。

  • 如果为浮点数，则抽取 max_samples * X.shape[0] 个样本。

  • 如果为“auto”，则 max_samples=min(256, n_samples)。

如果 max_samples 大于提供的样本数，则所有样本都将用于所有树（无抽样）。

contamination‘auto’ 或 float, 默认值=’auto’

数据集的污染量，即数据集中异常值的比例。用于拟合时定义样本分数的阈值。

  • 如果为“auto”，则阈值如原始论文中所述确定。

  • 如果为浮点数，则污染率应在 (0, 0.5] 范围内。

版本 0.22 中已更改: contamination 的默认值已从 0.1 更改为 'auto'。

max_featuresint 或 float, 默认值=1.0

从 X 中抽取用于训练每个基础估计器的特征数。

  • 如果为整数，则抽取 max_features 个特征。

  • 如果为浮点数，则抽取 max(1, int(max_features * n_features_in_)) 个特征。

注意：使用小于 1.0 的浮点数或小于特征数的整数将启用特征子采样，并导致更长的运行时间。

bootstrapbool, 默认值=False

如果为 True，则单个树将拟合在使用替换进行采样的训练数据的随机子集上。如果为 False，则执行无替换采样。

n_jobsint, 默认值=None

用于 fit 和 predict 的并行运行作业数。None 表示 1，除非在 joblib.parallel_backend 上下文中。-1 表示使用所有处理器。更多详情请参见 词汇表。

random_stateint, RandomState 实例或 None, 默认值=None

控制森林中每个分支步骤和每棵树的特征和分割值选择的伪随机性。

传递一个整数以获得跨多个函数调用的可重复结果。参见 词汇表。

verboseint, 默认值=0

控制树构建过程的详细程度。

warm_startbool, 默认值=False

设置为 True 时，重用先前对拟合的调用结果并将更多估计器添加到集成中，否则，只拟合一个全新的森林。参见 词汇表。

版本 0.21 中新增。

属性:
estimator_ExtraTreeRegressor 实例

用于创建已拟合子估计器集合的子估计器模板。

版本 1.2 中新增: base_estimator_ 已重命名为 estimator_。

estimators_ExtraTreeRegressor 实例列表

已拟合子估计器的集合。

estimators_features_ndarray 列表

每个基础估计器抽取的特征子集。

estimators_samples_ndarray 列表

每个基础估计器抽取的样本子集。

max_samples_int

样本的实际数量。

offset_float

用于根据原始分数定义决策函数的偏移量。我们有以下关系：decision_function = score_samples - offset_。offset_ 定义如下。当 contamination 参数设置为“auto”时，偏移量等于 -0.5，因为内点的分数接近 0，而异常点的分数接近 -1。当提供不同于“auto”的 contamination 参数时，偏移量的定义方式使得我们在训练中获得预期的异常值数量（决策函数 < 0 的样本）。

版本 0.20 中新增。

n_features_in_int

在 拟合期间看到的特征数量。

版本 0.24 中新增。

feature_names_in_形状为 (n_features_in_,) 的 ndarray

在 拟合期间看到的特征名称。仅当 X 的特征名称全部为字符串时才定义。

版本 1.0 中新增。

另请参阅

sklearn.covariance.EllipticEnvelope

用于检测高斯分布数据集中异常值的工具。

sklearn.svm.OneClassSVM

无监督异常值检测。估计高维分布的支持。该实现基于 libsvm。

sklearn.neighbors.LocalOutlierFactor

使用局部异常因子 (LOF) 进行无监督异常值检测。

备注

该实现基于 ExtraTreeRegressor 的集成。每棵树的最大深度设置为 ceil(log_2(n))，其中 \(n\) 是用于构建树的样本数（更多详情请参见 (Liu et al., 2008)）。

参考文献

[1]

Liu, Fei Tony, Ting, Kai Ming 和 Zhou, Zhi-Hua。“隔离森林。”数据挖掘，2008 年。第八届 IEEE 国际会议。

[2]

Liu, Fei Tony, Ting, Kai Ming 和 Zhou, Zhi-Hua。“基于隔离的异常检测。”ACM 从数据中发现知识的交易 (TKDD) 6.1 (2012): 3。

示例

>>> from sklearn.ensemble import IsolationForest
>>> X = [[-1.1], [0.3], [0.5], [100]]
>>> clf = IsolationForest(random_state=0).fit(X)
>>> clf.predict([[0.1], [0], [90]])
array([ 1,  1, -1])

有关使用隔离森林进行异常检测的示例，请参见 隔离森林示例。

decision_function(X)[source]#

基分类器的X的平均异常分数。

输入样本的异常分数计算为森林中树的平均异常分数。

给定一棵树，观察的正态性度量是包含该观察的叶子的深度，这等效于隔离该点所需的分割次数。如果叶子里有多个观察值n_left，则会加上n_left个样本隔离树的平均路径长度。

参数:
X形状为(n_samples, n_features)的{类数组，稀疏矩阵}

输入样本。内部将将其转换为dtype=np.float32，如果提供稀疏矩阵，则转换为稀疏csr_matrix。

返回:
scores形状为(n_samples,)的ndarray

输入样本的异常分数。分数越低，异常程度越高。负分表示异常值，正分表示内点。

备注

可以通过设置joblib上下文来并行化decision_function方法。这本身并不使用在类中初始化的n_jobs参数（该参数在fit期间使用）。这是因为，对于少量样本（例如1000个样本或更少），计算分数实际上可能比不并行化更快。用户可以在joblib上下文中设置作业数量来控制并行作业的数量。

from joblib import parallel_backend

# Note, we use threading here as the decision_function method is
# not CPU bound.
with parallel_backend("threading", n_jobs=4):
    model.decision_function(X)
property estimators_samples_#

每个基础估计器抽取的样本子集。

返回一个动态生成的索引列表，标识用于拟合集成每个成员的样本，即袋内样本。

注意：为了减少对象内存占用而不存储采样数据，该列表在每次调用属性时都会重新创建。因此，获取属性的速度可能会比预期慢。

fit(X, y=None, sample_weight=None)[source]#

拟合估计器。

参数:
X形状为(n_samples, n_features)的{类数组，稀疏矩阵}

输入样本。使用dtype=np.float32可获得最大效率。也支持稀疏矩阵，使用稀疏csc_matrix可获得最大效率。

y忽略

未使用，出于API一致性约定而存在。

sample_weight形状为(n_samples,)的类数组，默认为None

样本权重。如果为None，则样本的权重相等。

返回:
self对象

拟合后的估计器。

fit_predict(X, y=None, **kwargs)[source]#

对X进行拟合并返回X的标签。

对异常值返回 -1，对内点返回 1。

参数:
X形状为(n_samples, n_features)的{类数组，稀疏矩阵}

输入样本。

y忽略

未使用，出于API一致性约定而存在。

**kwargsdict

要传递给fit的参数。

1.4 版本中添加。

返回:
y形状为(n_samples,)的ndarray

内点为 1，异常值为 -1。

get_metadata_routing()[source]#

获取此对象的元数据路由。

请查看用户指南，了解路由机制的工作原理。

1.5 版本中添加。

返回:
routingMetadataRouter

一个MetadataRouter，封装了路由信息。

get_params(deep=True)[source]#

获取此估计器的参数。

参数:
deepbool，默认为True

如果为True，则将返回此估计器和包含的作为估计器的子对象的参数。

返回:
paramsdict

参数名称映射到其值。

predict(X)[source]#

预测特定样本是否为异常值。

参数:
X形状为(n_samples, n_features)的{类数组，稀疏矩阵}

输入样本。内部将将其转换为dtype=np.float32，如果提供稀疏矩阵，则转换为稀疏csr_matrix。

返回:
is_inlier形状为(n_samples,)的ndarray

对于每个观察值，根据拟合模型判断它是否(+1 或 -1)应该被视为内点。

备注

可以通过设置joblib上下文来并行化predict方法。这本身并不使用在类中初始化的n_jobs参数（该参数在fit期间使用）。这是因为，对于少量样本（例如1000个样本或更少），预测实际上可能比不并行化更快。用户可以在joblib上下文中设置作业数量来控制并行作业的数量。

from joblib import parallel_backend

# Note, we use threading here as the predict method is not CPU bound.
with parallel_backend("threading", n_jobs=4):
    model.predict(X)
score_samples(X)[source]#

与原始论文中定义的异常分数相反。

输入样本的异常分数计算为森林中树的平均异常分数。

给定一棵树，观察的正态性度量是包含该观察的叶子的深度，这等效于隔离该点所需的分割次数。如果叶子里有多个观察值n_left，则会加上n_left个样本隔离树的平均路径长度。

参数:
X形状为(n_samples, n_features)的{类数组，稀疏矩阵}

输入样本。

返回:
scores形状为(n_samples,)的ndarray

输入样本的异常分数。分数越低，异常程度越高。

备注

可以通过设置joblib上下文来并行化score_samples方法。这本身并不使用在类中初始化的n_jobs参数（该参数在fit期间使用）。这是因为，对于少量样本（例如1000个样本或更少），计算分数实际上可能比不并行化更快。用户可以在joblib上下文中设置作业数量来控制并行作业的数量。

from joblib import parallel_backend

# Note, we use threading here as the score_samples method is not CPU bound.
with parallel_backend("threading", n_jobs=4):
    model.score(X)
set_fit_request(*, sample_weight: bool | None | str = '$UNCHANGED$') → IsolationForest[source]#

向fit方法请求传递的元数据。

请注意，只有在enable_metadata_routing=True时（参见sklearn.set_config）, 此方法才相关。请参阅用户指南了解路由机制的工作原理。

每个参数的选项：

  • True：请求元数据，如果提供则传递给fit。如果未提供元数据，则忽略请求。

  • False：不请求元数据，元估计器不会将其传递给fit。

  • None：不请求元数据，如果用户提供元数据，元估计器将引发错误。

  • str：元数据应使用此给定的别名而不是原始名称传递给元估计器。

默认值（sklearn.utils.metadata_routing.UNCHANGED）保留现有的请求。这允许您更改某些参数的请求，而不对其他参数进行更改。

版本 1.3 中新增。

注意

仅当此估计器用作元估计器的子估计器时（例如，在Pipeline中使用）, 此方法才相关。否则它无效。

参数:
sample_weightstr, True, False 或 None，默认为 sklearn.utils.metadata_routing.UNCHANGED

fit 中sample_weight参数的元数据路由。

返回:
self对象

更新后的对象。

set_params(**params)[source]#

设置此估计器的参数。

此方法适用于简单估计器以及嵌套对象（例如Pipeline）。后者具有<component>__<parameter>形式的参数，以便可以更新嵌套对象的每个组件。

参数:
**paramsdict

估计器参数。

返回:
self估计器实例

估计器实例。