Skip to content

Files

Latest commit

Sep 8, 2022
0709733 · Sep 8, 2022

History

History
This branch is 1 commit behind XPixelGroup/BasicSR:master.

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
May 4, 2022
Jul 6, 2022
Aug 30, 2022
Jul 12, 2022
Nov 28, 2020
Jul 12, 2022
Jul 12, 2022
Sep 2, 2021
Sep 2, 2021
Jul 12, 2022
Sep 18, 2020
Sep 18, 2020
May 15, 2021
Nov 28, 2020
Nov 28, 2020
Aug 30, 2022
Oct 30, 2020
Jul 12, 2022
Sep 8, 2022
Apr 28, 2021
Apr 28, 2021
May 4, 2022
Sep 8, 2022
Oct 5, 2021
May 4, 2022
Jul 12, 2022
May 15, 2021
May 4, 2022

BasicSR docs

This folder includes:

中文文档

我们提供了更完整的 BasicSR 中文解读文档 PDF,你所需要的内容可以在相应的章节中找到。

文档的最新版可以从 BasicSR-docs/releases 下载。

欢迎大家一起来帮助查找文档中的错误,完善文档。

如何在本地自动生成 API docs

cd docs
make html

规范

rst 语法参考: https://3vshej.cn/rstSyntax/

着重几个点:

- 空行
- :file:`file`, :func:`func`, :class:`class`, :math:`\gamma`
- **粗体**,*斜体*
- ``Paper: title``
- Reference: link

Examples:

class SPyNetTOF(nn.Module):
    """SPyNet architecture for TOF.

    Note that this implementation is specifically for TOFlow. Please use :file:`spynet_arch.py` for general use.
    They differ in the following aspects:

    1. The basic modules here contain BatchNorm.
    2. Normalization and denormalization are not done here, as they are done in TOFlow.

    ``Paper: Optical Flow Estimation using a Spatial Pyramid Network``

    Reference: https://github.com/Coldog2333/pytoflow

    Args:
        load_path (str): Path for pretrained SPyNet. Default: None.
    """