From 0ef8bae721efcbe4e984e56a318c6bd1e5af9ffd Mon Sep 17 00:00:00 2001
From: Googlefan <google@neody.dev>
Date: Wed, 11 Sep 2024 05:03:50 +0000
Subject: [PATCH] feat: better README

---
 README.md | 41 +++++++++++++++++++++--------------------
 1 file changed, 21 insertions(+), 20 deletions(-)

diff --git a/README.md b/README.md
index 75448e3..374f10c 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,18 @@
 # sbv2-api
-このプロジェクトはStyle-Bert-ViTS2をONNX化したものをRustで実行するのを目的としています。つまり推論しか行いません。
+このプロジェクトはStyle-Bert-ViTS2をONNX化したものをRustで実行するのを目的としています。
 
-学習したいのであれば、Style-Bert-ViT2で調べてやってください。
+学習したい場合は、Style-Bert-ViTS2 学習方法 などで調べるとよいかもしれません。
 
-注意：JP-Extraしか対応していません。
+JP-Extraしか対応していません。(基本的に対応する予定もありません)
 
 ## ONNX化する方法
-dabertaとstbv2本体をonnx化する必要があります。
-
-あくまで推奨ですが、onnxsimを使うことをお勧めします。
-onnxsim使うことでモデルのサイズを軽くすることができます。
-
-## onnxモデルの配置方法
-- `models/daberta.onnx` - DaBertaのonnxモデル
-- `models/sbv2.onnx` - `Style-Bert-ViT2`の本体
+```sh
+cd convert
+# (何かしらの方法でvenv作成(推奨))
+pip install -r requirements.txt
+python convert_deberta.py
+python convert_model.py --style_file ../../style-bert-vits2/model_assets/something/style_vectors.npy --config_file ../../style-bert-vits2/model_assets/something/config.json --model_file ../../style-bert-vits2/model_assets/something/something_eXXX_sXXXX.safetensors
+```
 
 ## Todo
 - [x] WebAPIの実装
@@ -22,28 +21,30 @@ onnxsim使うことでモデルのサイズを軽くすることができます
 - [x] GPU対応(優先的にCUDA)
 - [ ] WASM変換(ortがサポートやめたので、中止)
 
-## ディレクトリー説明
-- `sbv2_api` - Style-Bert-VITS2の推論Web API
-- `sbv2_core` - Style-Bert-VITS2の推論コア部分
+## 構造説明
+- `sbv2_api` - 推論用 REST API
+- `sbv2_core` - 推論コア部分
+- `docker` - dockerビルドスクリプト
 
 ## APIの起動方法
-```bash
+```sh
 cargo run -p sbv2_api -r
 ```
 
 ### CUDAでの起動
-```bash
+```sh
 cargo run -p sbv2_api -r -F cuda,cuda_tf32
 ```
 
-### Dynamicのサポート
-```bash
+### Dynamic Linkサポート
+```sh
 ORT_DYLIB_PATH=./libonnxruntime.dll cargo run -p sbv2_api -r -F dynamic
 ```
 
 ### テストコマンド
-```bash
-curl -XPOST -H "Content-type: application/json" -d '{"text": "こんにちは"}' 'http://localhost:3000/synthesize'
+```sh
+curl -XPOST -H "Content-type: application/json" -d '{"text": "こんにちは","ident": "something"}' 'http://localhost:3000/synthesize'
+curl http://localhost:3000/models
 ```
 
 ## 謝辞