Add readthdocs for VisualDL. (#634)

* Add readthdocs for VisualDL.

* Update version to beta.1

* Fix readthdocs.

* Fix readthdocs.

* Fix readthdocs.

docs/Makefile

+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/README.md

-<p align="center">
-  <img src="/frontend/packages/core/public/images/logo-visualdl.svg" width="60%"/>
-</p>
-
-## 介绍
-VisualDL是一个面向深度学习任务设计的可视化工具，利用丰富的图表展示数据，用户可以更直观、清晰地查看数据的特征与变化趋势，有助于分析数据、及时发现错误，进而改进神经网络模型的设计。
-
-目前大多数DNN平台均使用Python作为配置语言，VisualDL原生支持python的使用，
-通过在模型的Python配置中添加几行，便可以为训练过程提供丰富的可视化支持。
-
-VisualDL拥有不同种类的组件，能够帮助开发者有效记录和监测训练中的各种指标和数据，为模型训练数据参考，及时发现错误，进而改进神经网络模型的设计，关于组件的具体信息可以参考[VisualDL组件](./components/README.md)。
-
-## 特点
-### 1 动态展示
-在启动VisualDL Board后，LogReader将不断增量的读取日志中数据并供前端调用展示，因此能够在训练中同步观测指标变化，如下图：
-
-<p align="center">
-  <img src="./images/dynamic_display.gif" width="60%"/>
-</p>
-
-### 2 多实验对比
-VisualDL支持多实验对比，只需要在启动VisualDL Board的时候将每个实验日志所在路径同时传入即可，每个实验中相同tag的指标将绘制在一张图中同步呈现，如下图：
-
-<p align="center">
-  <img src="./images/multi_experiments.gif" width="80%"/>
-</p>
-
-## 安装
-建议在anaconda环境下进行安装，便于开发环境的隔离，pip安装命令为：
-```shell
-python -m pip install visualdl
-```
-需要注意，由于官方不再维护Python2，因此VisualDL在v2.0.0之后的版本仅支持Python3
-
-## 使用
-### 记录日志
-VisualDL的后端提供了Python SDK，可通过LogWriter定制一个日志记录器，接口如下：
-```python
-class LogWriter(
-                logdir=None,
-                comment='',
-                max_queue=10,
-                flush_secs=120,
-                filename_suffix='',
-                write_to_disk=True,
-                **kwargs
-                )
-```
-接口参数说明如下：
-|参数|格式|含义|
-|-|-|-|
-|logdir|string|日志文件所在的路径，VisualDL将在此路径下建立日志文件并进行记录，如果不填则默认为`runs/${CURRENT_TIME}`|
-|comment|string|为日志文件夹名添加后缀，如果制定了logdir则此项无效|
-|max_queue|int|日志记录消息队列的最大容量，达到此容量则立即写入到日志文件|
-|flush_secs|int|日志记录消息队列的最大缓存时间，达到此时间则立即写入到日志文件|
-|filename_suffix|string|为默认的日志文件名添加后缀|
-|write_to_disk|boolean|是否写入到磁盘|
-
-初始化并记录标量数据到日志文件的过程如下：
-```python
-from visualdl import LogWriter
-
-# 在`./log/scalar_test/train`路径下建立日志文件
-with LogWriter(logdir="./log/scalar_test/train") as writer:
-    # 使用scalar组件记录一个标量数据
-    writer.add_scalar(tag="acc", step=1, value=0.5678)
-    writer.add_scalar(tag="acc", step=2, value=0.6878)
-    writer.add_scalar(tag="acc", step=3, value=0.9878)
-```
-关于LogWriter组件的更多具体用法，请参考[VisualDL组件](./components/README.md)
-
-
-### 启动面板
-我们已经记录了三个标量数据到日志中，现在可以启动VisualDL面板查看日志的可视化结果，启动方式分为两种：
-#### 在命令行启动
-我们可以使用命令行启动VisualDL面板，命令格式为：
-```shell
-visualdl --logdir <dir_1, dir_2, ... , dir_n> --host <host> --port <port>
-```
-参数意义分别为：
-- `--logdir` 设定日志所在目录，可以指定多个目录，VisualDL将遍历并且迭代寻找指定目录的子目录，将所有实验结果进行可视化
-- `--host` 设定IP，默认为`127.0.0.1`
-- `--port` 设定端口，默认为`8040`
-
-针对上一步生成的日志，我们的启动命令为
-```shell
-visualdl --logdir ./log
-```
-
-#### 在Python脚本中启动
-我们还可以在Python脚本中启动VisualDL面板，接口如下：
-
-```python
-visualdl.server.app.run(logdir,
-                        host="127.0.0.1",
-                        port=8080,
-                        cache_timeout=20,
-                        language=None,
-                        open_browser=False)
-```
-接口参数说明如下：
-|参数|格式|含义|
-|-|-|-|
-|logdir|string或list[string_1, string_2, ... , string_n]|日志文件所在的路径，VisualDL将在此路径下递归搜索日志文件并进行可视化，可指定单个或多个路径|
-|host|string|指定启动服务的ip，默认为`127.0.0.1`|
-|port|int|启动服务端口，默认为`8040`|
-|cache_timeout|int|后端缓存时间，在缓存时间内前端多次请求同一url，返回的数据从缓存中获取，默认为20秒|
-|language|string|VisualDL面板语言，可指定为'EN'或'CN'，默认自动匹配操作系统使用语言|
-|open_browser|boolean|是否打开浏览器，设置为True则在启动后自动打开浏览器并访问VisualDL面板|
-
-针对上一步生成的日志，我们的启动脚本为：
-```python
-from visualdl.server import app
-
-app.run(logdir="./log")
-```
-
-在使用任意一种方式启动VisualDL面板后，我们可以打开浏览器访问VisualDL面板，在面板上就可以看到日志的可视化结果，如图：
-<p align="center">
-  <img src="./images/3points_demo.png" width="60%"/>
-</p>

docs/conf.py

+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+from recommonmark.parser import CommonMarkParser
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../visualdl'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'VisualDL'
+copyright = '2020, PaddlePaddle'
+author = 'PaddlePaddle'
+
+# The full version, including alpha/beta/rc tags
+release = '2.0.0.beta1'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.mathjax',
+    'sphinx_markdown_tables',
+    'sphinx.ext.napoleon',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+source_parsers = {'.md': CommonMarkParser}
+
+source_suffix = ['.rst', '.md']
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = 'zh_CN'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

docs/index.rst

+.. VisualDL documentation master file, created by
+   sphinx-quickstart on Mon May 11 21:27:08 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to VisualDL's documentation!
+====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   概述<overview>
+
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/make.bat

+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/overview.md

+
+<p align="center">
+  <img src="http://visualdl.bj.bcebos.com/images/vdl-logo.png" width="70%"/>
+</p>
+
+[![Build Status](https://travis-ci.org/PaddlePaddle/VisualDL.svg?branch=develop)](https://travis-ci.org/PaddlePaddle/VisualDL)
+[![Documentation Status](https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat)](https://github.com/PaddlePaddle/VisualDL/tree/develop/docs)
+[![Release](https://img.shields.io/github/release/PaddlePaddle/VisualDL.svg)](https://github.com/PaddlePaddle/VisualDL/releases)
+[![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](LICENSE)
+
+## 介绍
+VisualDL是深度学习模型可视化分析工具，以丰富的图表呈现训练参数变化趋势、模型结构、数据样本、高维数据分布等。可帮助用户更清晰直观地理解深度学习模型训练过程及模型结构，进而实现高效的模型优化。
+
+VisualDL提供丰富的可视化功能，支持实时训练参数分析、图结构、数据样本可视化及高维数据降维呈现等诸多功能。具体功能使用方式，请参见 [**VisualDL使用指南**](./components/README.md)。项目正处于高速迭代中，敬请期待新组件的加入。
+
+VisualDL原生支持python的使用， 通过在模型的Python配置中添加几行代码，便可为训练过程提供丰富的可视化支持。
+
+## 目录
+
+* [核心亮点](#核心亮点)
+
+* [安装方式](#安装方式)
+
+* [使用方式](#使用方式)
+
+* [可视化功能概览](#可视化功能概览)
+
+* [开源贡献](#开源贡献)
+
+* [更多细节](#更多细节)
+
+
+
+## 核心亮点
+
+#### 简单易用
+
+API设计简洁易懂，使用简单。模型结构一键实现可视化。
+
+#### 功能丰富
+
+功能覆盖训练参数、图结构、数据样本及数据降维可视化。
+
+#### 高兼容性
+
+全面支持Paddle、ONNX、Caffe等市面主流模型结构可视化，广泛支持各类用户进行可视化分析。
+
+#### 全面支持
+
+与飞桨服务平台及工具组件全面打通，为您在飞桨生态系统中提供最佳使用体验。
+
+
+
+## 安装方式
+
+使用pip安装 VisualDL 运行范例：
+
+```shell
+pip install --upgrade visualdl==2.0.0a2
+```
+
+
+
+## 使用方式
+
+VisualDL将训练过程中的数据、参数等信息储存至日志文件中后，启动面板即可查看可视化结果。
+
+### 1. 记录日志
+
+VisualDL的后端提供了Python SDK，可通过LogWriter定制一个日志记录器，接口如下：
+
+```python
+class LogWriter(logdir=None,
+                comment='',
+                max_queue=10,
+                flush_secs=120,
+                filename_suffix='',
+                write_to_disk=True,
+                **kwargs)
+```
+
+#### 接口参数
+
+| 参数            | 格式    | 含义                                                         |
+| --------------- | ------- | ------------------------------------------------------------ |
+| logdir          | string  | 日志文件所在的路径，VisualDL将在此路径下建立日志文件并进行记录，如果不填则默认为`runs/${CURRENT_TIME}` |
+| comment         | string  | 为日志文件夹名添加后缀，如果制定了logdir则此项无效           |
+| max_queue       | int     | 日志记录消息队列的最大容量，达到此容量则立即写入到日志文件   |
+| flush_secs      | int     | 日志记录消息队列的最大缓存时间，达到此时间则立即写入到日志文件 |
+| filename_suffix | string  | 为默认的日志文件名添加后缀                                   |
+| write_to_disk   | boolean | 是否写入到磁盘                                               |
+
+#### 示例
+
+设置日志文件并记录标量数据：
+
+```python
+from visualdl import LogWriter
+
+# 在`./log/scalar_test/train`路径下建立日志文件
+with LogWriter(logdir="./log/scalar_test/train") as writer:
+    # 使用scalar组件记录一个标量数据
+    writer.add_scalar(tag="acc", step=1, value=0.5678)
+    writer.add_scalar(tag="acc", step=2, value=0.6878)
+    writer.add_scalar(tag="acc", step=3, value=0.9878)
+```
+
+### 2. 启动面板
+
+在上述示例中，日志已记录三组标量数据，现可启动VisualDL面板查看日志的可视化结果，共有两种启动方式：
+
+#### 在命令行启动
+
+使用命令行启动VisualDL面板，命令格式如下：
+
+```python
+visualdl --logdir <dir_1, dir_2, ... , dir_n> --host <host> --port <port>
+```
+
+参数详情：
+
+| 参数     | 意义                                                         |
+| -------- | ------------------------------------------------------------ |
+| --logdir | 设定日志所在目录，可以指定多个目录，VisualDL将遍历并且迭代寻找指定目录的子目录，将所有实验结果进行可视化 |
+| --host   | 设定IP，默认为`127.0.0.1`                                    |
+| --port   | 设定端口，默认为`8040`                                       |
+
+针对上一步生成的日志，启动命令为：
+
+```
+visualdl --logdir ./log
+```
+
+#### 在Python脚本中启动
+
+支持在Python脚本中启动VisualDL面板，接口如下：
+
+```python
+visualdl.server.app.run(logdir,
+                        host="127.0.0.1",
+                        port=8080,
+                        cache_timeout=20,
+                        language=None,
+                        open_browser=False)
+```
+
+接口参数：
+
+| 参数          | 格式                                             | 含义                                                         |
+| ------------- | ------------------------------------------------ | ------------------------------------------------------------ |
+| logdir        | string或list[string_1, string_2, ... , string_n] | 日志文件所在的路径，VisualDL将在此路径下递归搜索日志文件并进行可视化，可指定单个或多个路径 |
+| host          | string                                           | 指定启动服务的ip，默认为`127.0.0.1`                          |
+| port          | int                                              | 启动服务端口，默认为`8040`                                   |
+| cache_timeout | int                                              | 后端缓存时间，在缓存时间内前端多次请求同一url，返回的数据从缓存中获取，默认为20秒 |
+| language      | string                                           | VisualDL面板语言，可指定为'EN'或'CN'，默认自动匹配操作系统使用语言 |
+| open_browser  | boolean                                          | 是否打开浏览器，设置为True则在启动后自动打开浏览器并访问VisualDL面板 |
+
+针对上一步生成的日志，我们的启动脚本为：
+
+```python
+from visualdl.server import app
+
+app.run(logdir="./log")
+```
+
+在使用任意一种方式启动VisualDL面板后，打开浏览器访问VisualDL面板，即可查看日志的可视化结果，如图：
+
+<p align="center">
+  <img src="http://visualdl.bj.bcebos.com/images/3points_demo.png" width="60%"/>
+</p>
+
+
+
+## 可视化功能概览
+
+### Scalar
+以图表形式实时展示训练过程参数，如loss、accuracy。让用户通过观察单组或多组训练参数变化，了解训练过程，加速模型调优。具有两大特点：
+
+#### 动态展示
+
+在启动VisualDL Board后，LogReader将不断增量的读取日志中数据并供前端调用展示，因此能够在训练中同步观测指标变化，如下图：
+
+<p align="center">
+  <img src="http://visualdl.bj.bcebos.com/images/dynamic_display.gif" width="60%"/>
+</p>
+
+
+#### 多实验对比
+
+只需在启动VisualDL Board的时将每个实验日志所在路径同时传入即可，每个实验中相同tag的指标将绘制在一张图中同步呈现，如下图：
+
+<p align="center">
+  <img src="http://visualdl.bj.bcebos.com/images/multi_experiments.gif" width="100%"/>
+</p>
+
+
+### Image
+实时展示训练过程中的图像数据，用于观察不同训练阶段的图像变化，进而深入了解训练过程及效果。
+
+<p align="center">
+<img src="http://visualdl.bj.bcebos.com/images/image-eye.gif" width="60%"/>
+</p>
+
+
+### High Dimensional
+
+将高维数据进行降维展示，目前支持T-SNE、PCA两种降维方式，用于深入分析高维数据间的关系，方便用户根据数据特征进行算法优化。
+
+<p align="center">
+<img src="http://visualdl.bj.bcebos.com/images/high_dimensional_test.png" width="100%"/>
+</p>
+
+## 开源贡献
+
+VisualDL 是由 [PaddlePaddle](http://www.paddlepaddle.org/) 和 [ECharts](http://echarts.baidu.com/) 合作推出的开源项目。欢迎所有人使用，提意见以及贡献代码。
+
+
+## 更多细节
+
+想了解更多关于VisualDL可视化功能的使用详情介绍，请查看[**VisualDL使用指南**](./components/README.md)。

docs/requirements.txt

+sphinx==2.1.2
+sphinx-argparse==0.2.5
+sphinx-markdown-tables==0.0.12
+sphinx-rtd-theme==0.4.3
+recommonmark==0.6.0

requirements.txt

 numpy
 requests
-scipy == 1.2.3; python_version < "3.0"
-scipy >= 1.4.1; python_version >= "3.0"
 flake8 >= 3.7.9
-Pillow == 6.2.2; python_version < "3.0"
-Pillow >= 7.0.0; python_version >= "3.0"
+Pillow >= 7.0.0
 pre-commit
 flask >= 1.1.1
 Flask-Babel >= 1.0.0

visualdl/server/app.py

@@ -356,7 +356,7 @@ def _run(logdir,
         threading.Thread(
             target=_open_browser, kwargs={"app": app,
                                           "index_url": index_url}).start()
-    app.run(debug=False, host=args.host, port=args.port, threaded=True)
+    app.run(debug=False, host=args.host, port=args.port, threaded=False)
 
 
 def run(logdir,

visualdl/version.py

@@ -13,4 +13,4 @@
 # limitations under the License.
 # =======================================================================
 
-vdl_version = '2.0.0-alpha.4'
+vdl_version = '2.0.0-beta.1'