Skip to content

Commit

Permalink
Update: Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tsukumijima committed Nov 5, 2024
1 parent acbc584 commit 9731dc6
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
14 changes: 7 additions & 7 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ $ aivmlib show-metadata ./output.aivmx

学習済み AI 音声合成モデルと、その利用に必要な各種メタデータを単一ファイルにまとめることで、**ファイルの散逸や混乱を防ぎ、モデルの利用や共有を容易にすることを目的としている。**

> [!TIP]
> [!TIP]
> 単一ファイルにまとめることで、AIVM / AIVMX ファイルをダウンロードして所定のフォルダに配置するだけで、対応ソフトウェアですぐに音声合成モデルを利用できるようになるといった、シンプルな運用が可能になる。
> 圧縮ファイルではないため、展開の必要がないのもメリット。
Expand Down Expand Up @@ -318,7 +318,7 @@ ONNX ファイルは Protocol Buffers 形式で定義されており、ルート
AIVM マニフェストのデータ形式は、JSON フォーマットで記述された UTF-8 文字列である。
JSON フォーマットの都合上、画像や音声データは Base64 エンコードされた文字列で格納される。

> [!NOTE]
> [!NOTE]
> 現在 AIVM マニフェストのコンテナフォーマットとして定義されている AIVM (Safetensors) ・AIVMX (ONNX) のメタデータ領域はネストなしの string 型から string 型への key-value でなければならないため、すべてのメタデータを文字列にシリアライズして格納する仕様となっている。
> 画像や音声などのバイナリデータについては、Base64 エンコードを施した上で文字列として格納する。
Expand Down Expand Up @@ -487,11 +487,11 @@ AIVM メタデータは既存のモデルフォーマット仕様で定められ
- Python の `BinaryIO` が JavaScript Web API の `File` (Blob) になるなど、Web ブラウザの特性に応じた実装の違いはありますが、基本的な API 設計は aivmlib と同様です。
- Node.js や Deno などのサーバーサイド JavaScript 環境への対応予定はありません。

> [!TIP]
> [!TIP]
> 現時点では、aivmlib / [aivmlib-web](https://github.com/Aivis-Project/aivmlib-web) 以外に、公式にメンテナンスされる AIVM 仕様対応ライブラリはありません。
> 今後、サードパーティーの他言語向けライブラリが登場する可能性はあります。
> [!IMPORTANT]
> [!IMPORTANT]
> **新しいモデルアーキテクチャのサポートを追加する際は、aivmlib と [aivmlib-web](https://github.com/Aivis-Project/aivmlib-web) の両方に実装を追加する必要があります。**
> AIVM Generator は aivmlib-web を使用しているため、エンドユーザーに新機能を提供するためには両方のライブラリをアップデートする必要があります。
Expand All @@ -516,7 +516,7 @@ AIVM メタデータは既存のモデルフォーマット仕様で定められ
> 実装固有のハイパーパラメータは、`aivm_hyper_parameters` フィールドに格納してください。
> ハイパーパラメータの Pydantic スキーマ定義の追加も受け付けます。現在は `Style-Bert-VITS2` 系アーキテクチャのハイパーパラメータのスキーマのみが定義されています。
> [!NOTE]
> [!NOTE]
> 当然ですが、AIVM / AIVMX への変換元モデルは単一の Safetensors または ONNX 形式で保存されている必要があります。
> **したがって、複数のモデルファイルにまたがるモデルアーキテクチャはサポートされていません。**
> モデルファイルを一つに結合する、不要なモデルファイルを削るなどの対応をご検討ください。
Expand All @@ -539,14 +539,14 @@ URL 指定ではなくライセンス全文を埋め込む理由は以下の通
- 画像ファイル: 512×512 の JPEG または PNG (JPEG を推奨)
- 音声ファイル: WAV (PCM 16bit) または M4A (AAC-LC) (M4A を推奨)

> [!TIP]
> [!TIP]
> リファレンス実装である [AIVM Generator](https://aivm-generator.aivis-project.com/) では、これらのガイドラインに従って適切なサイズ最適化を行っています。
### Q. メタデータは手動で編集できますか?

**A. メタデータは直接バイナリに埋め込まれるため、手動編集は推奨されません。**
エンドユーザーの方は [AIVM Generator](https://aivm-generator.aivis-project.com/) をご利用ください。

> [!TIP]
> [!TIP]
> **開発者は、aivmlib / [aivmlib-web](https://github.com/Aivis-Project/aivmlib-web) を使用して独自のアプリケーションを作成できます。**
> aivmlib CLI は、最低限のメタデータを持つ AIVM / AIVMX ファイルの生成と、メタデータの確認機能のみを提供します。
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "aivmlib"
version = "1.0.0"
version = "1.0.0b0"
description = "Aivis Voice Model File (.aivm/.aivmx) Utility Library"
homepage = "https://github.com/Aivis-Project/aivmlib"
repository = "https://github.com/Aivis-Project/aivmlib"
Expand Down

0 comments on commit 9731dc6

Please sign in to comment.