Skip to content

Commit

Permalink
Fix readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
cryscan committed Oct 16, 2023
1 parent 2373fcb commit ca11745
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 109 deletions.
53 changes: 0 additions & 53 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ web-rwkv = { git = "https://github.com/cryscan/web-rwkv", branch = "main" }
memmap = "0.7"
bytemuck = "1"
regex = "1.8"
dialoguer = "0.10"
clap = { version = "4.3", features = ["derive"] }
serde = { version = "1", features = ["derive"] }
serde_json = "1"
Expand Down
27 changes: 9 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,31 +107,22 @@ QQ Group for communication: 30920262
## 📝Supported Arguments

* `--config`: Configure file path (default: `assets/Config.toml`)
* `--tokenizer`: Tokenizer path
* `--ip`: The IP address the server is bound to
* `--port`: Running port
* `--adapter`: Adapter (GPU and backend) selection options: `Auto` and `Manual`
* `--adapter_id`: Specify the adapter in CLI (overrides `--adapter`)

### Example

The server listens on port 3000, loads the full-layer quantized (32 > 24) 0.4B model, and selects the high-performance adapter.

```bash
$ cargo run --release -- --config assets/configs/Config.toml --port 3000 --adapter auto
```

## 📙Currently Available APIs

The API service starts at port 65530, and the data input and output format follow the Openai API specification.

* `/api/v1/models`
* `/api/models`
* `/api/v1/chat/completions`
* `/api/chat/completions`
* `/api/v1/completions`
* `/api/completions`
* `/api/v1/embeddings`
* `/api/embeddings`
* `/api/oai/v1/models`
* `/api/oai/models`
* `/api/oai/v1/chat/completions`
* `/api/oai/chat/completions`
* `/api/oai/v1/completions`
* `/api/oai/completions`
* `/api/oai/v1/embeddings`
* `/api/oai/embeddings`

## 📙WebUI Screenshots

Expand Down
28 changes: 9 additions & 19 deletions README_jp.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,32 +95,22 @@ OpenAIのChatGPT APIインターフェースと互換性があります。
## 📝サポートされている起動パラメーター

* `--config`: モデル設定ファイルのパス(既定:`assets/Config.toml`
* `--tokenizer`: トークナイザーのパス
* `--ip`: トークナイザーのパスサーバーにバインドされた IP アドレス
* `--port`: 実行ポート
* `--quant`: 量子化レイヤーの数を指定
* `--adapter`: アダプター(GPUおよびバックエンド)の選択オプション:`Auto``Manual`
* `--adapter_id`: CLIでアダプターを指定します(--adapterを上書きします)

### 例

サーバーはポート3000でリッスンし、全レイヤー量子化(32 > 24)の0.4Bモデルをロードし、高性能アダプターの自動選択。

```bash
$ cargo run --release -- --config assets/configs/Config.toml --port 3000 --adapter auto
```

## 📙現在利用可能なAPI

APIサービスは65530ポートで開始され、データ入力と出力の形式はOpenai APIの規格に従います。

* `/api/v1/models`
* `/api/models`
* `/api/v1/chat/completions`
* `/api/chat/completions`
* `/api/v1/completions`
* `/api/completions`
* `/api/v1/embeddings`
* `/api/embeddings`
* `/api/oai/v1/models`
* `/api/oai/models`
* `/api/oai/v1/chat/completions`
* `/api/oai/chat/completions`
* `/api/oai/v1/completions`
* `/api/oai/completions`
* `/api/oai/v1/embeddings`
* `/api/oai/embeddings`

## 📙WebUIスクリーンショット

Expand Down
27 changes: 9 additions & 18 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,31 +103,22 @@

## 📝支持的启动参数
- `--config`: 模型配置文件路径(默认`assets/Config.toml`
- `--tokenizer`: 词表路径
- `--ip`: 服务器绑定的IP地址
- `--port`: 运行端口
- `--adapter`: 适配器(GPU和后端)选择项:`Auto``Manual`
- `--adapter_id`: 在控制台指定适配器(覆写`--adapter`选项)

### 示例

服务器监听3000端口,加载全部层量化(32 > 24)的0.4B模型,自动选择高性能适配器。
```bash
$ cargo run --release -- --config assets/configs/Config.toml --port 3000 --adapter auto
```


## 📙目前可用的API

API 服务开启于 65530 端口, 数据输入已经输出格式遵循Openai API 规范。

- `/api/v1/models`
- `/api/models`
- `/api/v1/chat/completions`
- `/api/chat/completions`
- `/api/v1/completions`
- `/api/completions`
- `/api/v1/embeddings`
- `/api/embeddings`
- `/api/oai/v1/models`
- `/api/oai/models`
- `/api/oai/v1/chat/completions`
- `/api/oai/chat/completions`
- `/api/oai/v1/completions`
- `/api/oai/completions`
- `/api/oai/v1/embeddings`
- `/api/oai/embeddings`

## 📙WebUI 截图

Expand Down

0 comments on commit ca11745

Please sign in to comment.