Skip to content

Commit fc3664f

Browse files
xinntaoxinntao
committed
revise
1 parent 61fdef6 commit fc3664f

5 files changed

Lines changed: 18 additions & 22 deletions

File tree

‎latex/main.tex‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@
5151
\vspace{4cm}
5252
\normalfont \normalsize
5353
\horrule{0.5pt} \\[0.4cm]
54-
\huge \begin{CJK}{UTF8}{gbsn} BasicSR: 图像、视频复原增强开源库
55-
\\ 解读文档\end{CJK}
54+
\huge \begin{CJK}{UTF8}{gbsn} \quad BasicSR: 图像、视频超分复原增强开源库
55+
\\ 中文解读文档\end{CJK}
5656
\horrule{2pt} \\[0.5cm]
5757
}
5858

@@ -72,6 +72,7 @@
7272
\end{adjustwidth}
7373
\vspace{1.2cm}
7474
\begin{adjustwidth}{0.5cm}{}
75+
\hspace{-0.5cm}
7576
\includegraphics[width=0.07\textwidth]{figures/rocket_logo.png}
7677
\end{adjustwidth}
7778
\vspace{5cm}
@@ -96,18 +97,13 @@
9697
\vspace{0.5cm}
9798
\begin{CJK}{UTF8}{gbsn}
9899

99-
本文档的最新版可以从 \url{https://github.com/XPixelGroup/BasicSR-docs/releases} 下载。
100+
本文档的最新版可以从 \url{https://github.com/XPixelGroup/BasicSR-docs/releases} 下载
100101

101-
欢迎大家一起来帮助查找文档中的错误，完善文档。
102+
欢迎大家一起来帮助查找文档中的错误，完善文档
102103

103-
\faIcon{hand-point-right}快速跳转到\hyperref[toc]{文档主目录}。
104+
\hyperref[toc]{\faIcon{hand-point-right}点击快速跳转到\textbf{文档主目录}}
104105
\end{CJK}
105106

106-
%\vspace{0.3cm}
107-
% \href{https://github.com/FortsAndMills/RL-Theory-book}{xxx}.
108-
109-
110-
111107
% 作者页、目录
112108
\begin{CJK}{UTF8}{gbsn}
113109
\subfile{sections/authors.tex}

‎latex/sections/authors.tex‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@
1313
\begin{itemize}
1414
\item 王鑫涛 (Xintao Wang) ~\faIcon{envelope}~ xintao.alpha@gmail.com ~\faIcon{link}~ \url{https://xinntao.github.io/}
1515
%\item 张新栋 (Xindong Zhang)
16-
\item 谢良彬 (Liangbin Xie)
16+
\item 谢良彬 (Liangbin Xie) ~\faIcon{envelope}~ ~\faIcon{link}~ \url{https://liangbinxie.github.io/}
1717
\item 陈翔宇 (Xiangyu Chen) ~\faIcon{envelope}~ chxy95@gmail.com ~\faIcon{link}~ \url{https://chxy95.github.io/}
18-
\item 张文龙 (Wenlong Zhang)
19-
\item 刘翼豪 (Yihao Liu)
18+
\item 张文龙 (Wenlong Zhang) ~\faIcon{envelope}~ wenlong.zhang@connect.polyu.hk ~\faIcon{link}~ \url{https://wenlongzhang0517.github.io/}
19+
\item 刘翼豪 (Yihao Liu) ~\faIcon{envelope}~ ~\faIcon{link}~ \href{https://scholar.google.com.hk/citations?user=WRIYcNwAAAAJ}{Google Scholar}
2020
\item 孔祥涛 (Xiangtao Kong) ~\faIcon{envelope}~ kxtv587@gmail.com ~\faIcon{link}~ \url{https://xiangtaokong.github.io/}
21-
\item 顾津锦 (Jinjin Gu)
22-
\item 何静雯 (Jingwen He)
21+
\item 顾津锦 (Jinjin Gu) ~\faIcon{envelope}~ hellojasongt@gmail.com ~\faIcon{link}~ \url{https://www.jasongt.com/}
22+
\item 何静雯 (Jingwen He) ~\faIcon{envelope}~ ~\faIcon{link}~ \href{https://scholar.google.com/citations?user=GUxrycUAAAAJ}{Google Scholar}
2323
\item 董超 (Chao Dong) ~\faIcon{envelope}~ chao.dong@siat.ac.cn ~\faIcon{link}~ \href{https://scholar.google.com.hk/citations?user=OSDCB0UAAAAJ}{Google Scholar}
2424
\end{itemize}
2525

‎latex/sections/data_preparation.tex‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
\chapter{数据准备}\label{chapter:data_preparation}
66
\vspace{-2cm}
7-
这部分主要讲述数据存储形式，以及一些常见数据集的获取和描述。
7+
这部分主要讲述数据存储形式，FileClient 类，以及一些常见数据集的获取和描述。
88

99
% ------------------------------------------------------------------------------
1010
\section{常见用法}\label{data_preparation:common_use}
@@ -128,15 +128,15 @@ \section{meta 文件介绍}\label{data_preparation:meta_file}
128128

129129
\begin{enumerate}
130130
\item 制作 LMDB 后会同步产生一个 meta 文件，这个meta 有着自己固定的格式，不能修改，否则可能会影响 LMDB 数据的读取。详细参见章节\ref{data_preparation:lmdb}：\nameref{data_preparation:lmdb}
131-
\item PairedImageDataset 支持 \texttt{meta_info_file} 参数，会使用这个 meta 文件生成待读取的文件路径。这个可以根据用户自己的需要进行自定义
131+
\item PairedImageDataset 支持 \texttt{meta\_info\_file} 参数，会使用这个 meta 文件生成待读取的文件路径。这个可以根据用户自己的需要进行自定义
132132
\end{enumerate}
133133

134134
\todo{待完善}
135135

136136
% ----------------------------------
137137
\subsection{现有 meta 文件说明}\label{data_preparation:existing_meta_file}
138138

139-
在 \href{https://github.com/XPixelGroup/BasicSR/tree/master/basicsr/data/meta_info}{basicsr/data/meta_info} 目录下有提供了一些常用的 meta 文件，说明如下：
139+
在 \href{https://github.com/XPixelGroup/BasicSR/tree/master/basicsr/data/meta_info}{basicsr/data/meta\_info} 目录下有提供了一些常用的 meta 文件，说明如下：
140140

141141
\todo{待完善}
142142

@@ -145,7 +145,7 @@ \section{File Client 介绍}\label{data_preparation:file_client}
145145

146146
我们参考了 MMCV 的 FileClient 设计。为了使其兼容 BasicSR，我们对接口做了一些改动 (主要是为了适应 LMDB)。具体可以参见代码 \href{https://github.com/XPixelGroup/BasicSR/blob/master/basicsr/utils/file_client.py}{file\_client.py}。
147147

148-
\todo{后续添加详细说明}
148+
\todo{待完善}
149149

150150
% ------------------------------------------------------------------------------
151151
\section{常见数据集介绍与准备}\label{data_preparation:dataset}
@@ -232,7 +232,7 @@ \subsection{视频帧数据集 Vimeo90K}
232232
python scripts/data_preparation/create_lmdb.py --dataset vimeo90k
233233
\end{minted}
234234
注意选择 create\_lmdb\_for\_vimeo90k 函数，并需要修改函数相应的配置和路径
235-
\item 单元测试：我们可以单独测试 dataset 是否正常。注意修改函数相应的配置和路径：test\_scripts/test\_vimeo90k\_dataset.py。
235+
\item 单元测试：我们可以单独测试 dataset 是否正常。注意修改函数相应的配置和路径：test\_scripts/test\_vimeo90k\_dataset.py。
236236
\end{enumerate}
237237

238238
\end{document}

‎latex/sections/howto.tex‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ \section{添加修改指标}\label{howto:add_metric}
164164
\begin{enumerate}[第 1 步]
165165
\item 指标的存放与命名：指标文件存放在 \href{https://github.com/XPixelGroup/BasicSR/tree/master/basicsr/metrics}{basicsr/metrics/} 文件夹下。对于命名规则无要求，一般直接以功能命名即可，如 \href{https://github.com/XPixelGroup/BasicSR/tree/master/basicsr/metrics/psnr_ssim.py}{basicsr/metrics/psnr\_ssim.py}。
166166

167-
\item 编写自定义指标：在指标文件中对自定义指标函数进行命名，\textbf{需要注意新建函数名不能与已有函数名重复，否则会导致后续注册机制报错}。关于指标的功能详解见第\ref{chaper:metrics}章：\nameref{chaper:metrics}。在编写完自定义指标后，注意在 \href{https://github.com/XPixelGroup/BasicSR/tree/master/basicsr/metrics/__init__.py}{basicsr/metrics/\_\_init\_\_.py} 文件中对添加的自定义指标进行导入。以 \textbf{calculate\_psnr} 为例：
167+
\item 编写自定义指标：在指标文件中对自定义指标函数进行命名，\textbf{需要注意新建函数名不能与已有函数名重复，否则会导致后续注册机制报错}。关于指标的功能详解见第\ref{chapter:metrics}章：\nameref{chapter:metrics}。在编写完自定义指标后，注意在 \href{https://github.com/XPixelGroup/BasicSR/tree/master/basicsr/metrics/__init__.py}{basicsr/metrics/\_\_init\_\_.py} 文件中对添加的自定义指标进行导入。以 \textbf{calculate\_psnr} 为例：
168168
\begin{minted}[xleftmargin=20pt,linenos,bgcolor=bg]{python}
169169
from .psnr_ssim import calculate_psnr
170170
\end{minted}

‎latex/sections/metrics.tex‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ \section{如何使用指标}
126126
\subsection{通过配置文件指定}
127127

128128
在训练的 validation 阶段或者使用 \texttt{test.py} 测试时，我们可以在配饰文件中指定所需要使用的指标。这样程序就会自动计算相应指标了。
129-
比如下面的配置就会计算 PSNR 和 NIQE 的指标，分别调用了 \texttt{calculate_psnr} 和 \texttt{calculate_niqe}。
129+
比如下面的配置就会计算 PSNR 和 NIQE 的指标，分别调用了 \texttt{calculate\_psnr} 和 \texttt{calculate\_niqe}。
130130

131131
\begin{minted}[xleftmargin=20pt,bgcolor=bg,breaklines]{python}
132132
# validation settings

0 commit comments

Comments
 (0)