Skip to content

Commit 28fffef

Browse files
0x45f0x45f
authored
refine matrix_rank op code and doc (#35722)
1 parent 5548061 commit 28fffef

File tree

3 files changed

+34
-35
lines changed

3 files changed

+34
-35
lines changed

‎paddle/fluid/operators/matrix_rank_op.cc‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ namespace operators {
2727
using DDim = framework::DDim;
2828

2929
namespace detail {
30-
static DDim GetInputBatchDim(const DDim& dim_x) {
30+
static DDim CheckAndGetOutputDim(const DDim& dim_x) {
3131
auto x_vec = framework::vectorize(dim_x);
3232
if (x_vec.size() == 2) {
3333
return framework::make_ddim({1});
@@ -58,11 +58,8 @@ class MatrixRankeOp : public framework::OperatorWithKernel {
5858
"if hermitian == true, matrix should be n*n"));
5959
}
6060

61-
DDim dim_x_batch = detail::GetInputBatchDim(dim_x);
62-
if (ctx->Attrs().Get<bool>(
63-
"use_default_tol")) { // user not input TolTensor and tol
64-
ctx->SetOutputDim("Out", dim_x_batch);
65-
} else if (ctx->HasInput("TolTensor")) {
61+
DDim dim_x_batch = detail::CheckAndGetOutputDim(dim_x);
62+
if (ctx->HasInput("TolTensor")) {
6663
auto dim_tol = ctx->GetInputDim("TolTensor");
6764
if (dim_x_batch == dim_tol) {
6865
ctx->SetOutputDim("Out", dim_x_batch);
@@ -75,9 +72,6 @@ class MatrixRankeOp : public framework::OperatorWithKernel {
7572
GetBroadcastDimsArrays(dim_x_batch, dim_tol, x_batch_dims_array.data(),
7673
tol_dims_array.data(), out_dims_array.data(),
7774
max_dim, axis);
78-
for (auto& it : out_dims_array) {
79-
VLOG(3) << "out dims: " << it;
80-
}
8175
ctx->SetOutputDim("Out", framework::make_ddim(out_dims_array));
8276
}
8377
} else {
@@ -100,7 +94,9 @@ class MatrixRankeOpMaker : public framework::OpProtoAndCheckerMaker {
10094
public:
10195
void Make() override {
10296
AddInput("X", "(Tensor), The input tensor of matrix_rank op.");
103-
AddInput("TolTensor", "(optional) Tol tensor, shape is same as X batch.")
97+
AddInput("TolTensor",
98+
"(optional) Tol tensor, shape is same as X batch or can broadcast "
99+
"with X batch.")
104100
.AsDispensable();
105101
AddOutput("Out", "(Tensor), The output tensor of matrix_rank op.");
106102
AddAttr<float>("tol", "(float, optional). tol").SetDefault(0.0f);

‎python/paddle/fluid/tests/unittests/test_matrix_rank_op.py‎

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ def setUp(self):
3636
self.init_data()
3737
self.inputs = {'X': self.x}
3838
self.attrs = {'hermitian': self.hermitian}
39-
if self.tolTensor is not None:
40-
self.inputs["TolTensor"] = self.tolTensor
39+
if self.tol_tensor is not None:
40+
self.inputs["TolTensor"] = self.tol_tensor
4141
if self.tol is not None:
4242
self.attrs["tol"] = self.tol
4343
self.attrs["use_default_tol"] = self.use_default_tol
@@ -48,7 +48,7 @@ def test_check_output(self):
4848

4949
def init_data(self):
5050
self.x = np.eye(3, dtype=np.float32)
51-
self.tolTensor = None
51+
self.tol_tensor = None
5252
self.tol = 0.1
5353
self.use_default_tol = False
5454
self.hermitian = True
@@ -58,51 +58,56 @@ def init_data(self):
5858
class TestMatrixRankOP1(TestMatrixRankOP):
5959
def init_data(self):
6060
self.x = np.eye(3, k=1, dtype=np.float64)
61-
self.tolTensor = None
61+
self.tol_tensor = None
6262
self.tol = None
6363
self.use_default_tol = True
6464
self.hermitian = False
65-
self.out = np.linalg.matrix_rank(self.x, self.tolTensor, self.hermitian)
65+
self.out = np.linalg.matrix_rank(self.x, self.tol_tensor,
66+
self.hermitian)
6667

6768

6869
class TestMatrixRankOP2(TestMatrixRankOP):
6970
def init_data(self):
7071
self.x = np.random.rand(3, 4, 5, 6).astype(np.float32)
71-
self.tolTensor = np.random.random([3, 4]).astype(self.x.dtype)
72+
self.tol_tensor = np.random.random([3, 4]).astype(self.x.dtype)
7273
self.tol = None
7374
self.use_default_tol = False
7475
self.hermitian = False
75-
self.out = np.linalg.matrix_rank(self.x, self.tolTensor, self.hermitian)
76+
self.out = np.linalg.matrix_rank(self.x, self.tol_tensor,
77+
self.hermitian)
7678

7779

7880
class TestMatrixRankOP3(TestMatrixRankOP):
7981
def init_data(self):
8082
self.x = np.eye(200, dtype=np.float64)
81-
self.tolTensor = None
83+
self.tol_tensor = None
8284
self.tol = None
8385
self.use_default_tol = True
8486
self.hermitian = True
85-
self.out = np.linalg.matrix_rank(self.x, self.tolTensor, self.hermitian)
87+
self.out = np.linalg.matrix_rank(self.x, self.tol_tensor,
88+
self.hermitian)
8689

8790

8891
class TestMatrixRankOP4(TestMatrixRankOP):
8992
def init_data(self):
9093
self.x = np.random.rand(1, 10).astype(np.float32)
91-
self.tolTensor = None
94+
self.tol_tensor = None
9295
self.tol = None
9396
self.use_default_tol = True
9497
self.hermitian = False
95-
self.out = np.linalg.matrix_rank(self.x, self.tolTensor, self.hermitian)
98+
self.out = np.linalg.matrix_rank(self.x, self.tol_tensor,
99+
self.hermitian)
96100

97101

98102
class TestMatrixRankOP5(TestMatrixRankOP):
99103
def init_data(self):
100104
self.x = np.random.rand(5, 1).astype(np.float64)
101-
self.tolTensor = np.random.random([1, 4]).astype(self.x.dtype)
105+
self.tol_tensor = np.random.random([1, 4]).astype(self.x.dtype)
102106
self.tol = None
103107
self.use_default_tol = False
104108
self.hermitian = False
105-
self.out = np.linalg.matrix_rank(self.x, self.tolTensor, self.hermitian)
109+
self.out = np.linalg.matrix_rank(self.x, self.tol_tensor,
110+
self.hermitian)
106111

107112

108113
class TestMatrixRankAPI(unittest.TestCase):

‎python/paddle/tensor/linalg.py‎

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1106,20 +1106,18 @@ def matrix_rank(x, tol=None, hermitian=False, name=None):
11061106
r"""
11071107
Computes the rank of a matrix.
11081108
1109-
The rank of a matrix is the number of singular values that are greater than the specified tol threshold when hermitian=False,
1110-
or the number of eigenvalues in absolute value that are greater than the specified tol threshold when hermitian=True.
1109+
The rank of a matrix is the number of singular values that are greater than the specified `tol` threshold when hermitian=False,
1110+
or the number of eigenvalues in absolute value that are greater than the specified `tol` threshold when hermitian=True.
11111111
11121112
Args:
1113-
x (Tensor): The input tensor.
1114-
Its shape should be [..., m, n], where ... is zero or more batch dimensions. If x is a batch of matrices then the output
1115-
has the same batch dimensions. The data type of x should be float32 or float64.
1116-
tol (float,Tensor,optional): the tolerance value. Default: None.
1117-
If tol is not specified, and sigma is the largest singular value (or eigenvalue in absolute value), and eps is the
1118-
epsilon value for the dtype of x, then tol is computed with formula tol=sigma * max(m,n) * eps. Note that if x is
1119-
a batch of matrices, tol is computed this way for every batch.
1120-
hermitian (bool,optional): indicates whether x is Hermitian. Default: False.
1121-
When hermitian=True, x is assumed to be Hermitian, but x is not checked inside the function. Instead, We just use the
1122-
lower triangular of the matrix to compute.
1113+
x (Tensor): The input tensor. Its shape should be `[..., m, n]`, where `...` is zero or more batch dimensions. If `x` is a batch
1114+
of matrices then the output has the same batch dimensions. The data type of `x` should be float32 or float64.
1115+
tol (float,Tensor,optional): the tolerance value. Default: None. If `tol` is not specified, and `sigma` is the largest
1116+
singular value (or eigenvalues in absolute value), and `eps` is the epsilon value for the dtype of `x`, then `tol` is computed
1117+
with formula `tol=sigma * max(m,n) * eps`. Note that if `x` is a batch of matrices, `tol` is computed this way for every batch.
1118+
hermitian (bool,optional): indicates whether `x` is Hermitian. Default: False. When hermitian=True, `x` is assumed to be Hermitian,
1119+
enabling a more efficient method for finding eigenvalues, but `x` is not checked inside the function. Instead, We just use
1120+
the lower triangular of the matrix to compute.
11231121
name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.
11241122
11251123
Returns:

0 commit comments

Comments
 (0)