Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: YdrMaster <[email protected]>
  • Loading branch information
YdrMaster committed Feb 27, 2024
1 parent a1a8c7f commit d6890a4
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,19 @@
### 启动文本生成

```plaintext
cargo generate --model <model> --prompt <prompt> [--log <log>]
cargo generate --model <model> --prompt <prompt>
```

参数
必要参数

- `model`: 存放模型文件的目录,至少包含以下 3 个文件:
- `config.json`: 模型配置文件;
- `model.safetesnors`: 模型参数文件;
- `tokenizer.model`: 分词器词表;
> 目前仅支持 32000 词 BPE Tonkenizer。
- `prompt`: 生成文本的起始文本。
- `log` (optional, default = "warn"): 日志级别,可为 `off`/`trace`/`debug`/`info`/`warn`/`error`

其他参数参见 `cargo generate --help`

### 转换参数

Expand Down
2 changes: 1 addition & 1 deletion xtask/src/generate.rs
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ pub(crate) struct GenerateArgs {
/// Copy model parameters inside memory.
#[clap(short, long)]
inside_mem: bool,
/// Log level.
/// Log level, may be "off", "trace", "debug", "info" or "error".
#[clap(short, long)]
log: Option<String>,
}
Expand Down

0 comments on commit d6890a4

Please sign in to comment.