check_symmetric#

sklearn.utils.validation.check_symmetric(array, *, tol=1e-10, raise_warning=True, raise_exception=False)[source]#

确保数组是二维、方阵且对称的。

如果数组不对称，则返回其对称化版本。可选地，如果矩阵不对称，会引发警告或异常。

参数:

array{ndarray, 稀疏矩阵}: 要检查/转换的输入对象。必须是二维方阵，否则将引发 ValueError。
tol浮点数, 默认值=1e-10: 数组等价性的绝对容差。默认值 = 1E-10。
raise_warning布尔值, 默认值=True: 如果为 True，则在需要转换时引发警告。
raise_exception布尔值, 默认值=False: 如果为 True，则在数组不对称时引发异常。

返回:

array_sym{ndarray, 稀疏矩阵}: 输入数组的对称化版本，即 array 和 array.transpose() 的平均值。如果是稀疏矩阵，则首先对重复项求和并消除零值。

示例

>>> import numpy as np
>>> from sklearn.utils.validation import check_symmetric
>>> symmetric_array = np.array([[0, 1, 2], [1, 0, 1], [2, 1, 0]])
>>> check_symmetric(symmetric_array)
array([[0, 1, 2],
       [1, 0, 1],
       [2, 1, 0]])
>>> from scipy.sparse import csr_matrix
>>> sparse_symmetric_array = csr_matrix(symmetric_array)
>>> check_symmetric(sparse_symmetric_array)
<Compressed Sparse Row sparse matrix of dtype 'int64'
    with 6 stored elements and shape (3, 3)>

check_symmetric#

本页