diff --git a/README.md b/README.md index 4985d1df..d54f4bd8 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,16 @@ [English](/README_en.md) [Korean](/README_ko.md) ## What's New! -- VCClient is rebooted as version 2 !!! +- VCClientがセカンドバージョンとしてリブートしました。 + - 大幅なソフトウェア構造変更により拡張容易性を高めました。 + - REST APIを提供することでサードパーティによるクライアント開発を容易化しました。 + - エディション体系を刷新しました。 + - スタンダードエディション(win)はgpuの有無にかかわらず、onnxモデルでの実行を基本としてます。torchモデルはonnxモデルに変換してから使用してください。gpuをお持ちの方はonnxモデルでのみハードウェアアクセラレーションが有効となります。 + - Nvidiaのcudaエディション(win)は、torchモデルもハードウェアアクセラレーションが有効になります。また、onnxモデルもスタンダードエディションと比較してわずかながら性能が高くなる可能性があります。 + - macエディションはApple Silicon搭載のMacユーザ向けです。 + - linuxユーザやpythonの知識がある方はリポジトリをcloneして実行することもできます。 + - 現在のalpha versionではスタンダードエディションのみの提供となっています。 + # VC Client とは @@ -16,10 +25,26 @@ ![image](https://user-images.githubusercontent.com/48346627/206640768-53f6052d-0a96-403b-a06c-6714a0b7471d.png) -3. 複数のプラットフォームに対応しています。 +1. 複数のプラットフォームに対応しています。 - Windows, Mac(M1), Linux, Google Colab (MMVC のみ) +1. REST APIを提供しています。 + +- curlなどのOSに組み込まれているHTTPクライアントを使って操作ができます。 +- これにより、次のようなことが簡単に実現できます。 + - ユーザが.bat等でREST APIをたたく処理をショートカットとして登録する。 + - リモートから操作する簡易クライアントを作成する。 + - など。 + +# ダウンロード +[Hugging Face](https://huggingface.co/wok000/vcclient000/tree/main)からダウンロードしてください。 + +# マニュアル + +[マニュアル](docs/01_basic_v2.0.z.md) + + # トラブルシュート - [通信編](tutorials/trouble_shoot_communication_ja.md) diff --git a/README_en.md b/README_en.md index 1d6513d0..4394438c 100644 --- a/README_en.md +++ b/README_en.md @@ -3,7 +3,15 @@ [Japanese](/README.md) [Korean](/README_ko.md) ## What's New! -- VCClient is rebooted as version 2 !!! +- VCClient has rebooted as the second version. + - Significant software structural changes have enhanced extensibility. + - By providing REST API, it has become easier for third parties to develop clients. + - The edition system has been revamped. + - The Standard Edition (win) runs on onnx models by default, regardless of the presence of a GPU. Please convert torch models to onnx models before use. If you have a GPU, hardware acceleration is only effective with onnx models. + - The Nvidia cuda Edition (win) enables hardware acceleration for torch models as well. Additionally, onnx models might perform slightly better compared to the Standard Edition. + - The mac Edition is aimed at users with Macs equipped with Apple Silicon. + - Users with Linux and Python knowledge can clone the repository and run it. + - Currently, only the Standard Edition is available in the alpha version. # What is VC Client @@ -17,9 +25,23 @@ ![image](https://user-images.githubusercontent.com/48346627/206640768-53f6052d-0a96-403b-a06c-6714a0b7471d.png) -3. Cross-platform compatibility +1. Cross-platform compatibility Supports Windows, Mac (including Apple Silicon M1), Linux, and Google Colaboratory. +1. We provide a REST API. + +- You can operate it using HTTP clients that are built into the OS, such as curl. +- This allows you to easily achieve the following: + - Users can register processes that call the REST API in shortcuts, such as in .bat files. + - Create simple clients to operate remotely. + - And more. + +# Download +Please download it from [Hugging Face](https://huggingface.co/wok000/vcclient000/tree/main). + +# Manual + +[Manual](docs/01_basic_v2.0.z.md) # Software Signing diff --git a/README_ko.md b/README_ko.md index 8e2c68f2..295a604e 100644 --- a/README_ko.md +++ b/README_ko.md @@ -1,11 +1,18 @@ ## VC Client - [English](/README_en.md) [Japanese](/README.md) ## What's New! -- VCClient is rebooted as version 2 !!! - +- VCClient가 세컨드 버전으로 리부트되었습니다. + - 대대적인 소프트웨어 구조 변경으로 확장 용이성을 높였습니다. + - REST API를 제공하여 서드파티 클라이언트 개발을 용이하게 하였습니다. + - 에디션 체계를 새롭게 구성하였습니다. + - 스탠다드 에디션(win)은 GPU의 유무에 관계없이 onnx 모델로 실행하는 것을 기본으로 합니다. torch 모델은 onnx 모델로 변환한 후 사용하십시오. GPU를 보유한 경우 onnx 모델에서만 하드웨어 가속이 활성화됩니다. + - Nvidia의 cuda 에디션(win)은 torch 모델에서도 하드웨어 가속이 활성화됩니다. 또한, onnx 모델도 스탠다드 에디션과 비교할 때 성능이 약간 향상될 가능성이 있습니다. + - mac 에디션은 Apple Silicon을 탑재한 Mac 사용자용입니다. + - 리눅스 사용자 및 파이썬 지식이 있는 분은 리포지토리를 클론하여 실행할 수도 있습니다. + - 현재의 알파 버전에서는 스탠다드 에디션만 제공하고 있습니다. + # VC Client란 1. 각종 음성 변환 AI(VC, Voice Conversion)를 활용해 실시간 음성 변환을 하기 위한 클라이언트 소프트웨어입니다. 지원하는 음성 변환 AI는 다음과 같습니다. @@ -17,10 +24,26 @@ ![image](https://user-images.githubusercontent.com/48346627/206640768-53f6052d-0a96-403b-a06c-6714a0b7471d.png) -3. 여러 플랫폼을 지원합니다. +1. 여러 플랫폼을 지원합니다. - Windows, Mac(M1), Linux, Google Colab (MMVC만 지원) +1. REST API를 제공합니다. + +- curl과 같은 OS에 내장된 HTTP 클라이언트를 사용하여 조작할 수 있습니다. +- 이를 통해 다음과 같은 것을 쉽게 실현할 수 있습니다. + - 사용자가 .bat 등의 스크립트 파일로 REST API를 호출하는 처리를 바로가기로 등록한다. + - 원격에서 조작할 수 있는 간이 클라이언트를 작성한다. + - 등등. + +# 다운로드 +[Hugging Face](https://huggingface.co/wok000/vcclient000/tree/main)에서 다운로드하세요. + +# 매뉴얼 + +[매뉴얼](docs/01_basic_v2.0.z.md) + + # 문제 해결법 - [통신편](tutorials/trouble_shoot_communication_ko.md) diff --git a/docs/01_basic_v2.0.z.md b/docs/01_basic_v2.0.z.md new file mode 100644 index 00000000..ff16112e --- /dev/null +++ b/docs/01_basic_v2.0.z.md @@ -0,0 +1,62 @@ +# VCClient version 2.0.z マニュアル + +## version 体系 + +バージョンは x.y.z-a 形式で記載する。 + +| # | バージョン | 更新タイミング | +| --- | ------------------ | ----------------------------------- | +| x | メジャーバージョン | 大幅な変更 | +| y | マイナーバージョン | 機能追加、VCTypeの追加など | +| z | パッチバージョン | バグ修正。軽微な機能追加 | +| a | alpha, beta | aplha version, beta version等に付与 | + + +## edition + +| edition | os | 内容 | +| -------- | --- | -------------------------------------------------------------- | +| win_std | win | 一般的なwinユーザ向け。AMD, NvidiaのGPU所有者。CPUのみのユーザ | +| win_cuda | win | NvidiaのGPU所有者向け。cudaのセットアップが可能なユーザ | +| mac | mac | AppleSilicon(M1等)ユーザ向け。 | + +## サポート Voice Changer Type +| Voice Chanager Type | サポートエディション | | +| ----------------------- | ---------------------- | --------------------------------------------------------------------- | +| RVC | win_std, win_cuda, mac | https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI | +| Beatrice v2 API (alpha) | win_std, win_cuda | https://prj-beatrice.com/ | + + +## ダウンロード +hugging faceのリポジトリからダウンロードしてください。 +ファイル名は次のフォーマットになっています。 + +``` +vcclient__.zip +``` + +## インストール +ダウンロードしたファイルを解凍してください。 + +解凍先のフォルダパスにASCII以外の文字が含まれている場合に起動しない場合があります。 + + +## アンインストール +解凍したフォルダを削除してください。 + +## 操作 +### 起動方法 +| 起動ファイル | サポートエディション | 説明 | +| --------------- | -------------------- | ---------------------------------------------- | +| start_http.bat | win_std, win_cuda | 一般的な起動方法 | +| start_https.bat | win_std, win_cuda | リモートからブラウザアクセスする場合の起動方法 | + +初回起動時のみ、必要なデータのダウンロードが行われます。しばらくお待ちください。 + +### 終了方法 +ターミナル上で"q"をタイプすることで終了することもできます。 +ネイティブクライアントが立ち上がっている場合はネイティブクライアントをクローズすると終了できます。 + + + +## \ No newline at end of file