Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[docs] ユーザーガイドを追加 #699

Merged
merged 11 commits into from
Dec 4, 2023
Merged

[docs] ユーザーガイドを追加 #699

merged 11 commits into from
Dec 4, 2023

Conversation

Hiroshiba
Copy link
Member

@Hiroshiba Hiroshiba commented Dec 1, 2023 •
edited
Loading

内容

コア0.15用のユーザーガイドを追加してみました。
とりあえず音声合成までの一通りの流れと、AudioQueryを使った簡単なサンプルを紹介しています。

ユーザー辞書の使い方も書こうかなと思ったのですが、一旦完成を優先してペンディングにしています。

ちょっと言葉の使い方が不自然な箇所がちらほらある気がしています･･･。一旦これでもいいのかなと思っていますが、ちょっと変えた方が良さそうな点などがあれば教えてください。

関連 Issue

その他

  • なんとなく気にしていた書き方の規則
    • 「CORE」という言葉は使わずに「コア」にする
    • ～してください　→　～します
    • 難しい言葉をできる限り使わない
    • ドメイン用語を使う
    • アルファベットを用いる単語の場合、ソースコード内の概念にのみシングルクオートを使う

sevenc-nanashi
sevenc-nanashi reviewed Dec 1, 2023
View reviewed changes
docs/usage.md
Comment on lines +43 to +49
> [!NOTE]
> Downloader を実行すればコアの動的ライブラリもダウンロードされているので、Python ライブラリを用いない場合はこの章はスキップできます。

`pip install`で Python ライブラリをインストールします。使いたい OS・アーキテクチャ・デバイス・バージョンによって URL が変わるので、[最新のリリース](https://github.com/VOICEVOX/voicevox_core/releases/latest/)の`Python wheel`に合わせます。

```sh
pip install https://github.com/VOICEVOX/voicevox_core/releases/download/[バージョン]/voicevox_core-[バージョン]+[デバイス]-cp38-abi3-[OS・アーキテクチャ].whl
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ここら辺しんどいのでリポジトリ作って（ #489 ）それを使うようにしたいですね…

docs/usage.md Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Show resolved Hide resolved
sevenc-nanashi
sevenc-nanashi reviewed Dec 1, 2023
View reviewed changes
docs/usage.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#674 にこのファイルも入れたいですね。

@Hiroshiba @sevenc-nanashi
Update docs/usage.md
7080d48 
Co-authored-by: Nanashi. <[email protected]>
Hiroshiba
Hiroshiba commented Dec 2, 2023
View reviewed changes
Copy link
Member Author

@Hiroshiba Hiroshiba left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

あ！　レビューありがとうございます！！

qryxip
qryxip approved these changes Dec 3, 2023
View reviewed changes
Copy link
Member

@qryxip qryxip left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

一点ありますが、LGTM!

docs/usage.md Outdated

VOICEVOX の音声合成のコア部分で、VOICEVOX 音声合成が可能です。

コアを利用する方法は２つあります。動的ライブラリを直接実行する方法と、各言語向けのライブラリをインストールする方法です。初心者の方は後者がおすすめです。
Copy link
Member

@qryxip qryxip Dec 3, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Python APIやJava APIはC/ENGINE向けのlibvoicevox_coreを含んでいるわけではないので、「直接実行」というのは若干語弊がありそう?

Copy link
Member Author

@Hiroshiba Hiroshiba Dec 4, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

おっと！
僕もPython APIやJava APIは動的ライブラリを直接実行する方法だとは思ってない感じです！
どこかテキストに語弊がある箇所がありそうなのですが、どのあたりからどう判断されましたか？
（文面的にややこしい部分があれば崩しておいた方が良さそうだなと思って聞いてみました）

Copy link
Member Author

@Hiroshiba Hiroshiba Dec 4, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ここで大事なのは動的ライブラリがあるということと、各言語向けのライブラリもあるということかなと思いました！
それと「直接」という言葉の裏に「間接」という言葉もあり、片方が直接実行ならもう片方は間接実行かなと深読みする人もいるかもですかね。

なのでこんな感じにしてみたいと思います。

コアを利用する方法は２つあります。動的ライブラリを使う方法と、各言語向けのライブラリを使う方法です。初心者の方は後者がおすすめです。

@Hiroshiba
Copy link
Member Author

このユーザーガイドですが、プログラミングを始めて3ヶ月くらいとかの右も左もわからない人でもまあ始めてみようかなと思えるぐらい（あるいはちょっとレベル足りないからまた来ようと思えるくらいの）を目指してみました。
なので正確な言い回しよりも、おじ気づかない言葉遣いを目指しています。（正確性がわかる人はそもそもこのガイドラインがなくても進める）
今後ずっとそうであるべきかどうかわからないですが、一旦気持ちとして共有です！

問題ないと思うのでマージしたいと思います！
レビューありがとうございました！！

@Hiroshiba Hiroshiba merged commit 67c0852 into VOICEVOX:main Dec 4, 2023
28 checks passed
@Hiroshiba Hiroshiba deleted the ユーザーガイド追加 branch December 4, 2023 17:25
qryxip added a commit to qryxip/voicevox_core that referenced this pull request Dec 8, 2023
@qryxip
VOICEVOX#699 のusage.mdを更新
5000662
Hiroshiba pushed a commit that referenced this pull request Dec 9, 2023
@qryxip
PythonのブロッキングAPIを実装 (#706)
00a1c53 
* `blocking.{OpenJtalk,UserDict}`

* `voicevox_core.asyncio`

* Blackとisortに`--diff`を付ける

* isort

* `blocking.{Synthesizer,VoiceModel}`

* `add_class`

* example/python/run.pyをブロッキング版に

* テストをコピペで実装

* #701 の動作チェックにrun-asyncio.pyを追加

* `shell: bash`

* #699 のusage.mdを更新

* スタイルの統一

* run-asyncio.pyのコメント変更
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sevenc-nanashi sevenc-nanashi sevenc-nanashi left review comments

@qryxip qryxip qryxip approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Hiroshiba @qryxip @sevenc-nanashi