diff --git a/README.cn.md b/README.cn.md index 19587e8b07091d205d0f737a928f8672f0eed177..1d4e846bfaed6316694683e80e8ac9a1ea2352f2 100644 --- a/README.cn.md +++ b/README.cn.md @@ -48,6 +48,18 @@ VisualDL 目前支持4种组件:

+## 快速尝试 +``` +# 安装 +pip install --upgrade visualdl + +# 运行一个例子 +vdl_scratch.py +visualDL --logdir=scratch_log --port=8080 + +# 访问 http://127.0.0.1:8080 +``` + ## SDK VisualDL 同时提供了python SDK 和 C++ SDK 来实现不同方式的使用。 ### Python SDK @@ -64,7 +76,7 @@ logger = LogWriter(dir, sync_cycle=10) with logger.mode("train"): # create a scalar component called 'scalars/scalar0' scalar0 = logger.scalar("scalars/scalar0") - + # add some records during DL model running. for step in range(100): scalar0.add_record(step, random.random()) @@ -83,12 +95,12 @@ namepsace cp = visualdl::components; int main() { const std::string dir = "./tmp"; vs::LogWriter logger(dir, 10); - + logger.SetMode("train"); auto tablet = logger.NewTablet("scalars/scalar0"); - + cp::Scalar scalar0(tablet); - + for (int step = 0; step < 1000; step++) { float v = (float)std::rand() / RAND_MAX; scalar0.AddRecord(step, v); @@ -113,5 +125,5 @@ board 还支持一下参数来实现远程的访问: ### 贡献 -VisualDL 是由 [PaddlePaddle](http://www.paddlepaddle.org/) 和 -[ECharts](http://echarts.baidu.com/) 合作推出的开源项目。我们欢迎所有人使用,提意见以及贡献代码。 +VisualDL 是由 [PaddlePaddle](http://www.paddlepaddle.org/) 和 +[ECharts](http://echarts.baidu.com/) 合作推出的开源项目。我们欢迎所有人使用,提意见以及贡献代码。 diff --git a/README.md b/README.md index ce249e0393ba4ec49865d862744a07e2378e064a..fae9bfda144fd906e0f6a7736c1cc7012314c803 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,18 @@ Histogram can be used to visualize parameter distribution and trends for any ten

+## Quick Start +``` +# install +pip install --upgrade visualdl + +# run a demo +vdl_scratch.py +visualDL --logdir=scratch_log --port=8080 + +# visit http://127.0.0.1:8080 +``` + ## SDK VisualDL provides both Python SDK and C++ SDK in order to fit more use cases.