add reader docs (#848)

* add faq.md

docs/components/README.md

@@ -768,3 +768,61 @@ visualdl service upload --logdir ./log \
    <p align="center">
     <img src="https://user-images.githubusercontent.com/48054808/93733790-69e8ef80-fc09-11ea-9256-68a88072f5d2.png" width="100%"/>
   </p>
+
+
+## LogReader
+
+### 简介
+VisualDL可通过LogReader获取保存的日志中所有数据，帮助用户进行更详细的分析工作。
+
+### 使用方式
+
+### 1. 获取LogReader实例
+
+LogReader的初始化接口如下：
+```python
+class LogReader(logdir=None,
+                file_name='')
+```
+#### 接口参数
+
+| 参数            | 格式    | 含义                                                         |
+| --------------- | ------- | ------------------------------------------------------------ |
+| logdir          | string  | 日志文件所在的路径，必填|
+| file_name       | string  | 指定要读的日志文件名，必填|
+
+#### 示例
+
+假定在`./log`文件夹下有一个日志文件`vdlrecords.1605533348.log`，则获取LogReader实例如下：
+
+```python
+from visualdl import LogReader
+
+reader = LogReader(logdir='./log', file_name='vdlrecords.1605533348.log')
+```
+
+### 2. 获取所有数据的tag信息
+通过接口`tags()`可获取LogReader实例对应日志中的所有数据tag信息，如下：
+```python
+tags = reader.tags()
+```
+结果如下，格式为`${file_name}/${tag}:${component_name}`
+```python
+{'vdlrecords.1605533348.log/meta_data_tag': 'meta_data', 'vdlrecords.1605533348.log/Metrics%Training(Step): loss': 'scalar', 'vdlrecords.1605533348.log/Metrics%Training(Step): acc1': 'scalar', 'vdlrecords.1605533348.log/Metrics%Training(Step): acc5': 'scalar', 'vdlrecords.1605533348.log/Metrics%Training(Step): lr': 'scalar', 'vdlrecords.1605533348.log/Metrics%Eval(Epoch): acc1': 'scalar', 'vdlrecords.1605533348.log/Metrics%Eval(Epoch): acc5': 'scalar'}
+```
+
+### 3. 获取某tag对应的数据
+通过接口`get_data(component, tag)`可获取某组件某tag对应的所有数据，例如：
+```python
+# 获取scalar组件tag为`Metrics%Training(Step): loss`的数据
+data = reader.get_data('scalar', 'Metrics%Training(Step): loss')
+```
+结果为列表形式，如下
+```python
+...
+id: 5
+tag: "Metrics/Training(Step): loss"
+timestamp: 1605533356039
+value: 3.1297709941864014
+...
+```
\ No newline at end of file

docs/faq.md

+# 常见问题
+
+## 打开浏览器出现空白或者发生错误
+可参照下列步骤排除错误原因
+1. 确保启动VisualDL时指定的`logdir`路径正确，并确保其下有符合命名要求（文件名包含`vdlrecords`）的日志文件，可进入`logdir`指定的文件夹先行查看。若未解决，转下步。
+2. 确认浏览器及版本符合VisualDL要求，建议使用**最新版本**的chrome及chrome内核浏览器、火狐浏览器，尝试更换浏览器及升级到最新版本。若未解决，转下步。
+3. 将`--host`参数指定为`0.0.0.0`或`127.0.0.1`，注意后者仅支持本机查看，若在服务器启动并在异地查看，需使用`0.0.0.0`并确保使用的端口可被外网访问。若未解决，转下步。
+4. 关闭并重新打开VisualDL前端页面，或强制刷新浏览器并等待15-30秒。若未解决，转下步。
+5. 若是windows机器，可查看是否注册表被修改，参考解决[解决注册表修改导致无法查看日志](https://github.com/PaddlePaddle/VisualDL/issues/834)
+若经过上述尝试仍无法解决，可在VisualDL GitHub Issue进行提问[VDL Issue](https://github.com/PaddlePaddle/VisualDL/issues)
+
+## 使用Image、Audio、Text组件仅显示10个样本
+为保证使用体验，防止由于数据量过大造成前端页面卡死或崩溃，在展示Image、Audio、Text组件时使用采样算法进行了数据采样后展示。  
+尽管数据在前端展示进行了采样，但在日志中保存的数据仍为全部数据，可通过`VisualDL.LogReader`进行全部数据获取，可参考[LogReader使用教程](./components#LogReader)
+
+## 为什么Scalar绘制的曲线是迂回的
+当你发现绘制的曲线如下图所示，某个step对应的value不止一个值时，请检查你的脚本，是否在使用`add_scalar`时为一个step重复添加了多次value。
+<p align="center">
+    <img src="https://user-images.githubusercontent.com/28444161/99496785-de44d280-29af-11eb-8fbd-ebc7a4919f2f.png" width="40%"/>
+</p>
+
+

visualdl/version.py

@@ -13,4 +13,4 @@
 # limitations under the License.
 # =======================================================================
 
-vdl_version = '2.0.4'
+vdl_version = '2.0.5'