Skip to content

Commit 253a96b

Browse files
committed
chore: update version to 0.1.3; enhance documentation with new import paths and usage examples for CLI and web interface
1 parent f5ca8d0 commit 253a96b

File tree

12 files changed

+24
-10
lines changed

12 files changed

+24
-10
lines changed

docs/api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- v0.1.0 -->
12

23
# API 文档
34

docs/arch.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- v0.1.0 -->
2+
13
# FlowLine 架构说明
24

35
## 系统架构图

docs/design.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- v0.1.0 -->
2+
13
# FlowLine 概要设计
24

35
## 系统概述

docs/readme_en.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- v0.1.2 -->
1+
<!-- v0.1.3 -->
22

33
<div align="center">
44
<img src="./fig/logo.png" width="50%" alt="FlowLine" />
@@ -28,6 +28,8 @@ The system was designed to replace the inefficient manual process of monitoring
2828

2929
## 🚀 Quick Start Guide
3030

31+
> For a concise demonstration, see [example.sh](./example.sh) which provides all usage examples.
32+
3133
### 🖥️ Using Command Line Interface (CLI Mode)
3234

3335
#### 1. Installation
@@ -82,7 +84,7 @@ You need to define a custom function that constructs the final command string us
8284

8385
Example:
8486
```python
85-
from flowline import run_cli
87+
from flowline.api import run_cli
8688

8789
if __name__ == "__main__":
8890
def func(param_dict, gpu_id):
@@ -187,6 +189,8 @@ Run the Flask backend:
187189
python test/example_server.py
188190
```
189191

192+
> Note: Web interface uses `from flowline.api.routes import get_app` to import routes.
193+
190194
#### 2. Start Frontend Service
191195
Launch static file server:
192196
```bash

flowline/__init__.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
from .api import get_app, run_cli
1+
# from .api import get_app, run_cli
2+
# from .api.routes import get_app
3+
from .api.interface import run_cli

flowline/api/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
from .routes import get_app
1+
# from .routes import get_app
22
from .interface import run_cli

flowline/core/__init__.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
from .program import ProgramManager
2-
from ..api.interface import run_cli
1+
from .program import ProgramManager

readme.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,8 @@ pip install -e <flowline库路径>
9191
详见 [example1_cli.py](./test/example1_cli.py) 示例。主要部分如下:
9292

9393
```python
94+
from flowline.api import run_cli
95+
9496
def func(dict, gpu_id, sorted_gpu_ids):
9597
return "CUDA_VISIBLE_DEVICES="+str(gpu_id)+" python -u test/test.py "+ " ".join([f"--{k} {v}" for k, v in dict.items()])
9698

@@ -220,6 +222,8 @@ python test/example1_cli.py
220222
python test/example_server.py
221223
```
222224

225+
> 注:Web 界面使用 `from flowline.api.routes import get_app` 导入路由。
226+
223227
### 2. 启动前端界面服务
224228

225229
使用 Python 自带 HTTP 服务器提供静态前端页面:

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
from setuptools import setup, find_packages
22
import os
33

4-
base_version = "0.1.2"
4+
base_version = "0.1.3"
55
build_timestamp = os.getenv('BUILD_TIMESTAMP', None)
66

77
if build_timestamp:

test/example1_cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# 命令行调用示例
2-
from flowline import run_cli
2+
from flowline.api import run_cli
33

44
def func(dict, gpu_id, sorted_gpu_ids):
55
# ! 这里需要修改为你的命令

0 commit comments

Comments
 (0)