mirrors
/
mmcv
mirror of https://github.com/open-mmlab/mmcv.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[Doc] Fix invalid symbols in docstring

pull/1468/head
MeowZheng 2021-11-07 22:49:48 +08:00 committed by Wenwei Zhang
parent e22740b1d6
commit cfa5fc8489
3 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
mmcv/ops/correlation.py
View File

@ -118,20 +118,20 @@ class Correlation(nn.Module):
There are two batched tensors with shape :math:`(N, C, H, W)`, There are two batched tensors with shape :math:`(N, C, H, W)`,
and the correlation output's shape is and the correlation output's shape is
:math:`(N, \text{max_displacement} \times 2+1, :math:`(N, \text{max\_displacement} \times 2+1,
\text{max_displacement} \times 2+1, \text{max\_displacement} \times 2+1,
H_{out}, W_{out})` H_{out}, W_{out})`
where where
.. math:: .. math::
H_{out} = \left\lfloor\frac{H_{in} + 2 \times \text{padding} - H_{out} = \left\lfloor\frac{H_{in} + 2 \times \text{padding} -
\text{dilation} \times (\text{kernel_size} - 1) - 1} \text{dilation} \times (\text{kernel\_size} - 1) - 1}
{\text{stride}} + 1\right\rfloor {\text{stride}} + 1\right\rfloor
.. math:: .. math::
W_{out} = \left\lfloor\frac{W_{in} + 2 \times \text{padding} - W_{out} = \left\lfloor\frac{W_{in} + 2 \times \text{padding} -
\text{dilation} \times (\text{kernel_size} - 1) - 1} \text{dilation} \times (\text{kernel\_size} - 1) - 1}
{\text{stride}} + 1\right\rfloor {\text{stride}} + 1\right\rfloor
the correlation item :math:`(N_i, dy, dx)` is formed by taking the sliding the correlation item :math:`(N_i, dy, dx)` is formed by taking the sliding

2
mmcv/ops/group_points.py
View File

@ -71,7 +71,7 @@ class QueryAndGroup(nn.Module):
center_xyz (Tensor): (B, npoint, 3) coordinates of the centriods. center_xyz (Tensor): (B, npoint, 3) coordinates of the centriods.
features (Tensor): (B, C, N) Descriptors of the features. features (Tensor): (B, C, N) Descriptors of the features.
Return： Return:
Tensor: (B, 3 + C, npoint, sample_num) Grouped feature. Tensor: (B, 3 + C, npoint, sample_num) Grouped feature.
""" """
# if self.max_radius is None, we will perform kNN instead of ball query # if self.max_radius is None, we will perform kNN instead of ball query

4
mmcv/ops/points_sampler.py
View File

@ -95,7 +95,7 @@ class PointsSampler(nn.Module):
points_xyz (Tensor): (B, N, 3) xyz coordinates of the features. points_xyz (Tensor): (B, N, 3) xyz coordinates of the features.
features (Tensor): (B, C, N) Descriptors of the features. features (Tensor): (B, C, N) Descriptors of the features.
Return： Return:
Tensor: (B, npoint, sample_num) Indices of sampled points. Tensor: (B, npoint, sample_num) Indices of sampled points.
""" """
indices = [] indices = []
@ -166,7 +166,7 @@ class FSSampler(nn.Module):
super().__init__() super().__init__()
def forward(self, points, features, npoint): def forward(self, points, features, npoint):
"""Sampling points with FS_Sampling.""" r"""Sampling points with FS\_Sampling."""
assert features is not None, \ assert features is not None, \
'feature input to FS_Sampler should not be None' 'feature input to FS_Sampler should not be None'
ffps_sampler = FFPSSampler() ffps_sampler = FFPSSampler()