Merge branch 'develop' of github.com:VisualDL/VisualDL into feature/refactor_storage_interface

README.md

-# VisualDL
\ No newline at end of file
+# VisualDL
+
+
+### How to use
+#### Step 1: build and install Python package
+```shell
+python setup.py bdist_wheel
+cd dist
+pip install visualdl-0.0.1-py2-none-any.whl
+```
+
+#### Step 2: build frontend
+```shell
+cd visualdl/frontend
+npm install
+npm run build
+```
+
+### Step 3: run
+```
+python bin/visual_dl.py --port=8888
+```

bin/visual_dl.py

 """ entry point of visual_dl
 """
 import json
+import os
+import sys
 from optparse import OptionParser
 
-from flask import Flask
-from flask import request
+from flask import Flask, redirect
+from flask import send_from_directory
 
 from visualdl.log import logger
 
-app = Flask(__name__)
+app = Flask(__name__, static_url_path="")
 
 
 def option_parser():
@@ -44,12 +46,23 @@ def gen_result(status, msg):
     return result
 
 
-@app.route('/')
+server_path = os.path.abspath(os.path.dirname(sys.argv[0]))
+static_file_path = "../visualdl/frontend/dist/"
+
+
+@app.route('/static/<path:filename>')
+def serve_static(filename):
+    return send_from_directory(
+        os.path.join(server_path, static_file_path), filename)
+
+
+@app.route("/")
 def index():
-    """
+    return redirect('/static/index.html', code=302)
 
-    :return:
-    """
+
+@app.route('/hello')
+def hello():
     result = gen_result(0, "Hello, this is VisualDL!")
     return json.dumps(result)
 

docs/backend_architecture.md

@@ -48,4 +48,3 @@ IM 与 Server 的关系是
 ### Protobuf API
 - 决定了底层的数据格式，protobuf 提供了序列化的公共界面
 - SDK通过Protobuf API操作底层数据
-

docs/data_structure.md

@@ -159,7 +159,7 @@ histogram 需要得到tensor的分布，因此会把完整的tensor 的数值存
 ]
 ```
 
-## graph 
+## graph
 graph 会复杂一些，可能无法借用上述类型
 
 ```javascript

docs/visualization.md

@@ -6,4 +6,4 @@
 
 # 前端增量
 
-# 前端采样
\ No newline at end of file
+# 前端采样

setup.py

 from setuptools import setup
 
-setup(name="visualdl",
-      version="0.0.1",
-      packages=['visualdl'],
-      include_package_data=True,
-      install_requires=[
-        'flask>=0.12.1'
-      ],
-      url='http://www.baidu.com/',
-      license='Apache 2.0',
-)
+setup(
+    name="visualdl",
+    version="0.0.1",
+    packages=['visualdl'],
+    include_package_data=True,
+    install_requires=['flask>=0.12.1'],
+    url='http://www.baidu.com/',
+    license='Apache 2.0', )

visualdl/__init__.py

 import log
 
-__all__ = [
-    'log'
-]
+__all__ = ['log']

visualdl/backend/test.py

@@ -46,11 +46,7 @@ class TabletTester(unittest.TestCase):
         scalar = self.tablet.as_float_scalar()
         py_captions = ["train", "test"]
         step_ids = [10, 20, 30]
-        py_records = [
-            [0.1, 0.2],
-            [0.2, 0.3],
-            [0.3, 0.4]
-        ]
+        py_records = [[0.1, 0.2], [0.2, 0.3], [0.3, 0.4]]
 
         scalar.set_captions(py_captions)
         for i in range(len(py_records)):

visualdl/frontend/src/index.js

@@ -6,4 +6,3 @@ new App({
         titleName: 'VisualDL'
     }
 }).attach(document.getElementById('root'));
-