From d2591d3e42b0c2d04a0cbcc7e61b78fe4eebc1cd Mon Sep 17 00:00:00 2001 From: YixinKristy <48054808+YixinKristy@users.noreply.github.com> Date: Mon, 21 Sep 2020 14:30:33 +0800 Subject: [PATCH] Update Eng and Chinese Readme & User-guide (add instructions of VDL.service) (#821) * Update README.md Co-authored-by: ShenYuhan --- README-en.md | 10 +++++- README.md | 10 +++++- docs/README-en.md | 12 +++++-- docs/README.md | 11 ++++++- docs/components/README.md | 56 +++++++++++++++++++++++++++++++-- docs/components/UserGuide-en.md | 55 +++++++++++++++++++++++++++++++- 6 files changed, 146 insertions(+), 8 deletions(-) diff --git a/README-en.md b/README-en.md index 5a333982..77e53490 100644 --- a/README-en.md +++ b/README-en.md @@ -19,7 +19,7 @@ ## Introduction VisualDL, a visualization analysis tool of PaddlePaddle, provides a variety of charts to show the trends of parameters, and visualizes model structures, data samples, histograms of tensors, pr curves and high-dimensional data distributions. It enables users to understand the training process and the model structure more clearly and intuitively so as to optimize models efficiently. -VisualDL provides various visualization functions, including tracking metrics in real-time, visualizing the model structure, displaying the data sample, presenting the changes of distributions of tensors, showing the pr curves, projecting high-dimensional data to a lower dimensional space and more. For specific guidelines of each function, please refer to [**VisualDL User Guide**](./docs/components/UserGuide-en.md). Currently, VisualDL iterates rapidly and new functions will be continously added. +VisualDL provides various visualization functions, including tracking metrics in real-time, visualizing the model structure, displaying the data sample, presenting the changes of distributions of tensors, showing the pr curves, projecting high-dimensional data to a lower dimensional space and more. Additionally, VisualDL provides VDL.service, which enables developers easily to save, track and share visualization results of experiments. For specific guidelines of each function, please refer to [**VisualDL User Guide**](./docs/components/UserGuide-en.md). Currently, VisualDL iterates rapidly and new functions will be continously added. VisualDL natively supports the use of Python. Developers can retrieve plentiful visualization results by simply adding a few lines of Python code into the model before training. @@ -262,6 +262,14 @@ Histogram displays how the trend of tensors (weight, bias, gradient, etc.) chang

+### VDL.service + +**VDL.service** enables developers to easily save, track and share visualization results with anyone for free. + +

+ + ## Contribution VisualDL, in which Graph is powered by [Netron](https://github.com/lutzroeder/netron), is an open source project supported by [PaddlePaddle](https://www.paddlepaddle.org/) and [ECharts](https://echarts.apache.org/) . Developers are warmly welcomed to use, comment and contribute. diff --git a/README.md b/README.md index 45ba98fb..f0327f18 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ ## 介绍 VisualDL是飞桨可视化分析工具，以丰富的图表呈现训练参数变化趋势、模型结构、数据样本、高维数据分布等。可帮助用户更清晰直观地理解深度学习模型训练过程及模型结构，进而实现高效的模型优化。 -VisualDL提供丰富的可视化功能，支持标量、图结构、数据样本可视化、直方图、PR曲线及高维数据降维呈现等诸多功能。具体功能使用方式，请参见 [**VisualDL使用指南**](./docs/components/README.md)。项目正处于高速迭代中，敬请期待新组件的加入。 +VisualDL提供丰富的可视化功能，支持标量、图结构、数据样本可视化、直方图、PR曲线及高维数据降维呈现等诸多功能，同时VisualDL提供可视化结果保存服务，通过VDL.service生成链接，保存并分享可视化结果。具体功能使用方式，请参见 [**VisualDL使用指南**](./docs/components/README.md)。项目正处于高速迭代中，敬请期待新组件的加入。 VisualDL支持浏览器种类：Chrome（81和83）、Safari 13、FireFox（77和78）、Edge（Chromium版）。 @@ -282,6 +282,14 @@ app.run(logdir="./log")

+### VDL.service + +VisualDL可视化结果保存服务，以链接形式将可视化结果保存下来，方便用户快速、便捷的进行托管与分享。 + +

+ +

+ ## 开源贡献 VisualDL 是由 [PaddlePaddle](https://www.paddlepaddle.org/) 和 [ECharts](https://echarts.apache.org/) 合作推出的开源项目。 diff --git a/docs/README-en.md b/docs/README-en.md index ecb4f977..0c85ed9b 100644 --- a/docs/README-en.md +++ b/docs/README-en.md @@ -19,7 +19,7 @@ ## Introduction VisualDL, a visualization analysis tool of PaddlePaddle, provides a variety of charts to show the trends of parameters, and visualizes model structures, data samples, histograms of tensors, pr curves and high-dimensional data distributions. It enables users to understand the training process and the model structure more clearly and intuitively so as to optimize models efficiently. -VisualDL provides various visualization functions, including tracking metrics in real-time, visualizing the model structure, displaying the data sample, presenting the changes of distributions of tensors, showing the pr curves, projecting high-dimensional data to a lower dimensional space and more. For specific guidelines of each function, please refer to [**VisualDL User Guide**](./docs/components/UserGuide-en.md). Currently, VisualDL iterates rapidly and new functions will be continously added. +VisualDL provides various visualization functions, including tracking metrics in real-time, visualizing the model structure, displaying the data sample, presenting the changes of distributions of tensors, showing the pr curves, projecting high-dimensional data to a lower dimensional space and more. Additionally, VisualDL provides VDL.service, which enables developers easily to save, track and share visualization results of experiments. For specific guidelines of each function, please refer to [**VisualDL User Guide**](./docs/components/UserGuide-en.md). Currently, VisualDL iterates rapidly and new functions will be continously added. VisualDL natively supports the use of Python. Developers can retrieve plentiful visualization results by simply adding a few lines of Python code into the model before training. @@ -240,7 +240,7 @@ Developers can compare with multiple experiments by specifying and uploading the ### Histogram -Histogram displays how the trend of tensors (weight, bias, gradient, etc.) changes during the training process in the form of histogram. Developers can adjust the model structures accurately by having an in-depth understanding of the effect of each layer. +**Histogram** displays how the trend of tensors (weight, bias, gradient, etc.) changes during the training process in the form of histogram. Developers can adjust the model structures accurately by having an in-depth understanding of the effect of each layer. - Offset Mode @@ -263,6 +263,14 @@ Histogram displays how the trend of tensors (weight, bias, gradient, etc.) chang

+### VDL.service + +**VDL.service** enables developers to easily save, track and share visualization results with anyone for free. + +

+ + ## Contribution VisualDL, in which Graph is powered by [Netron](https://github.com/lutzroeder/netron), is an open source project supported by [PaddlePaddle](https://www.paddlepaddle.org/) and [ECharts](https://echarts.apache.org/) . Developers are warmly welcomed to use, comment and contribute. diff --git a/docs/README.md b/docs/README.md index 2cd3c800..3d6a9255 100644 --- a/docs/README.md +++ b/docs/README.md @@ -20,7 +20,7 @@ ## 介绍 VisualDL是飞桨可视化分析工具，以丰富的图表呈现训练参数变化趋势、模型结构、数据样本、高维数据分布等。可帮助用户更清晰直观地理解深度学习模型训练过程及模型结构，进而实现高效的模型优化。 -VisualDL提供丰富的可视化功能，支持标量、图结构、数据样本可视化、直方图、PR曲线及高维数据降维呈现等诸多功能。具体功能使用方式，请参见 [**VisualDL使用指南**](./components/README.md)。项目正处于高速迭代中，敬请期待新组件的加入。 +VisualDL提供丰富的可视化功能，支持标量、图结构、数据样本可视化、直方图、PR曲线及高维数据降维呈现等诸多功能，同时VisualDL提供可视化结果保存服务，通过VDL.service生成链接，保存并分享可视化结果。具体功能使用方式，请参见 [**VisualDL使用指南**](./components/README.md)。项目正处于高速迭代中，敬请期待新组件的加入。 VisualDL支持浏览器种类：Chrome（81和83）、Safari 13、FireFox（77和78）、Edge（Chromium版）。 @@ -280,6 +280,15 @@ app.run(logdir="./log")

+### VDL.service + +VisualDL可视化结果保存服务，以链接形式将可视化结果保存下来，方便用户快速、便捷的进行托管与分享。 + +

+ +

+ + ## 开源贡献 VisualDL 是由 [PaddlePaddle](https://www.paddlepaddle.org/) 和 [ECharts](https://echarts.apache.org/) 合作推出的开源项目。 diff --git a/docs/components/README.md b/docs/components/README.md index b5cad517..b403292e 100644 --- a/docs/components/README.md +++ b/docs/components/README.md @@ -18,7 +18,7 @@ VisualDL 是一个面向深度学习任务设计的可视化工具。VisualDL | [PR Curve](#PR-Curve--PR曲线组件) | 折线图 | 权衡精度与召回率之间的平衡关系 | | [High Dimensional](#High-Dimensional--数据降维组件) | 数据降维 | 将高维数据映射到 2D/3D 空间来可视化嵌入，便于观察不同数据的相关性 | - +同时，VisualDL提供可视化结果保存服务，通过 [VDL.service](#VDL.service) 生成链接，保存并分享可视化结果 ## Scalar--标量组件 @@ -93,7 +93,7 @@ visualdl --logdir ./log --port 8080 接着在浏览器打开`http://127.0.0.1:8080`，即可查看以下折线图。

- +

- 多组实验对比 @@ -173,6 +173,25 @@ visualdl --logdir ./log --port 8080

+* 选择显示最值，展示最大最小值以及对应的训练步数 + +

+ +

+ +

+ +

+ +* 选择仅显示平滑后的数据 + +

+ +

+ +

+ +

* X轴有三种衡量尺度 @@ -716,3 +735,36 @@ visualdl --logdir ./log --port 8080

+ + +## VDL.service + +### 简介 + +VisualDL可视化结果保存服务，以链接形式将可视化结果保存下来，方便用户快速、便捷的进行托管与分享。 + +### 使用步骤 + +1. 确保VisualDL已升级到最新版本，如未升级，请使用以下命令进行升级 + +``` +pip install visualdl --upgrade + +``` + +2. 上传需保存/分享的日志/模型文件 + +``` +visualdl service upload --logdir ./log \ + --model ./__model__ +``` + +3. VDL.service将返回一个URL链接，复制粘贴链接至浏览器中即可查看可视化结果 + +

+ +

+ +

+ +

diff --git a/docs/components/UserGuide-en.md b/docs/components/UserGuide-en.md index fe7747bc..5e8920c1 100644 --- a/docs/components/UserGuide-en.md +++ b/docs/components/UserGuide-en.md @@ -10,6 +10,7 @@ Currently, VisualDL provides seven components: scalar, image, audio, graph, hist + | Component Name | Display Chart | Function | | :----------------------------------------------------------: | :---------------------------: | :----------------------------------------------------------- | | [ Scalar](#Scalar--Line-Chart) | Line Chart | Display scalar data such as loss and accuracy dynamically. | @@ -20,7 +21,7 @@ Currently, VisualDL provides seven components: scalar, image, audio, graph, hist | [PR Curve](#PR-Curve) | Precision & Recall Curve | Display precision-recall curves across training steps, clarifying the tradeoff between precision and recall when comparing models. | | [High Dimensional](#High-Dimensional--Data-Dimensionality-Reduction) | Data Dimensionality Reduction | Project high-dimensional data into 2D/3D space for embedding visualization, making it convenient to observe the correlation between data. | - +At the same time, VisualDL provides [VDL.service](#VDL.service) , which allows developers to easily save, track and share visualization results of experiments with anyone for free. ## Scalar--Line Chart @@ -174,6 +175,25 @@ Then, open the browser and enter the address: `http://127.0.0.1:8080` to view li

+* Display the global extrema + +

+ +

+ +

+ +

+ +* Only display smoothed data + +

+ +

+ +

+ +

* There are three measurement scales of X axis @@ -719,3 +739,36 @@ Then, open the browser and enter the address`http://127.0.0.1:8080` to view:

+ + +## VDL.service + +### Introduction + +VDL.service enables developers to easily save, track and share visualization results with anyone for free. + +### Usage Steps + +1. Make sure that your get the lastest version of VisualDL, if not, please update by: + +``` +pip install visualdl --upgrade + +``` + +2. Upload log/model to save, track and share the visualization results. + +``` +visualdl service upload --logdir ./log \ + --model ./__model__ +``` + +3. An unique URL will be given. Then you can view the visualization results by simply copying and pasting the URL to the browser. + +

+ +

+ +

+ +

-- GitLab