diff --git a/README.md b/README.md index 798ae32..593a410 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,6 @@

AstrAI

- -
- English • - 中文 -
-

A lightweight Transformer training & inference framework

@@ -80,7 +74,7 @@ pip install -e ".[dev]" #### Train a Model ```bash -python tools/train.py \ +python scripts/tools/train.py \ --train_type=seq \ --data_root_path=/path/to/dataset \ --param_path=/path/to/param_path @@ -89,25 +83,25 @@ python tools/train.py \ #### Generate Text ```bash -python tools/generate.py --param_path=/path/to/param_path +python scripts/tools/generate.py --param_path=/path/to/param_path ``` #### Demo -Check out the demos in the `demo/` folder: +Check out the demos in the `scripts/demo/` folder: ```bash # Download pre‑processed data (required before running demos) -python demo/download.py +python scripts/demo/download.py # Interactive streaming chat -python demo/stream_chat.py +python scripts/demo/stream_chat.py # Batch generation -python demo/generate_batch.py +python scripts/demo/generate_batch.py # Auto‑regressive generation -python demo/generate_ar.py +python scripts/demo/generate_ar.py ``` Watch a video walkthrough on [bilibili](https://www.bilibili.com/video/BV1z5RPYHEkd). diff --git a/assets/docs/README-zh-CN.md b/assets/docs/README-zh-CN.md index b976748..36dc289 100644 --- a/assets/docs/README-zh-CN.md +++ b/assets/docs/README-zh-CN.md @@ -75,7 +75,7 @@ pip install -e ".[dev]" #### 训练模型 ```bash -python tools/train.py \ +python scripts/tools/train.py \ --train_type=seq \ --data_root_path=/path/to/dataset \ --param_path=/path/to/param_path @@ -84,25 +84,25 @@ python tools/train.py \ #### 文本生成 ```bash -python tools/generate.py --param_path=/path/to/param_path +python scripts/tools/generate.py --param_path=/path/to/param_path ``` #### 演示 -查看 `demo/` 文件夹中的演示: +查看 `scripts/demo/` 文件夹中的演示: ```bash # 下载预处理数据(运行演示前必需) -python demo/download.py +python scripts/demo/download.py # 交互式流式聊天 -python demo/stream_chat.py +python scripts/demo/stream_chat.py # 批量生成 -python demo/generate_batch.py +python scripts/demo/generate_batch.py # 自回归生成 -python demo/generate_ar.py +python scripts/demo/generate_ar.py ``` 观看 [bilibili](https://www.bilibili.com/video/BV1z5RPYHEkd) 上的视频演示。 diff --git a/demo/download.py b/scripts/demo/download.py similarity index 100% rename from demo/download.py rename to scripts/demo/download.py diff --git a/demo/generate_ar.py b/scripts/demo/generate_ar.py similarity index 100% rename from demo/generate_ar.py rename to scripts/demo/generate_ar.py diff --git a/demo/generate_batch.py b/scripts/demo/generate_batch.py similarity index 100% rename from demo/generate_batch.py rename to scripts/demo/generate_batch.py diff --git a/demo/stream_chat.py b/scripts/demo/stream_chat.py similarity index 100% rename from demo/stream_chat.py rename to scripts/demo/stream_chat.py diff --git a/tools/benchmark.py b/scripts/tools/benchmark.py similarity index 100% rename from tools/benchmark.py rename to scripts/tools/benchmark.py diff --git a/tools/generate.py b/scripts/tools/generate.py similarity index 100% rename from tools/generate.py rename to scripts/tools/generate.py diff --git a/tools/perplexity.py b/scripts/tools/perplexity.py similarity index 100% rename from tools/perplexity.py rename to scripts/tools/perplexity.py diff --git a/tools/train.py b/scripts/tools/train.py similarity index 100% rename from tools/train.py rename to scripts/tools/train.py