Merge branch 'main' into change-liberate-voicevox-core

.github/actions/install-cargo-deny/action.yml

@@ -0,0 +1,11 @@
+name: Install cargo-deny
+description: cargo-denyをインストールする。
+
+runs:
+  using: composite
+  steps:
+    - name: Install cargo-binstall
+      uses: taiki-e/install-action@cargo-binstall
+    - name: Install cargo-deny
+      shell: bash
+      run: cargo binstall cargo-deny@^0.16 --no-confirm --log-level debug

.github/workflows/audit.yml

@@ -0,0 +1,24 @@
+# 依存ライブラリを監査する。
+#
+# RustSec Advisory Databaseに登録された、あるいは単にヤンクされたクレートを検出する。
+# 検出されるものは脆弱性（`vulnerability`）のみとは限らない。
+# 依存ライブラリが単に"unmaintained"とされたりヤンクされたりしても反応する。
+
+name: audit
+
+# データベースへの登録とクレートのヤンクはこちらの依存ライブラリの編集と関係なく起きるため、`push`
+# と`pull_request`はトリガーにしない。
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 15 * * *'
+
+jobs:
+  audit:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install cargo-deny
+        uses: ./.github/actions/install-cargo-deny
+      - name: cargo-deny
+        run: cargo deny --all-features check -s advisories

.github/workflows/licenses.yml

@@ -0,0 +1,22 @@
+# 依存ライブラリのライセンスを確認する。
+#
+# `advisories`以外についてcargo-denyを実行する。
+
+name: licenses
+
+# 外部からの貢献者の負担を減らすため、PR時点では不適合になることを許容する。その代わりmainブランチで
+# は毎回本ワークフローを実行する。
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  licenses:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install cargo-deny
+        uses: ./.github/actions/install-cargo-deny
+      - name: cargo-deny
+        run: cargo deny --all-features check -s bans licenses sources

crates/voicevox_core/src/nonblocking.rs

@@ -9,8 +9,13 @@
 //! スレッドプールのサイズは、blockingクレートの説明にある通り`$BLOCKING_MAX_THREADS`で調整すること
 //! ができる。
 //!
+//! また未調査ではあるが、このモジュールについては[`cpu_num_threads`]は物理コアの数+1を指定するのが適切な可能性がある
+//! ([VOICEVOX/voicevox_core#902])。
+//!
 //! [blocking]: https://docs.rs/crate/blocking
 //! [pollster]: https://docs.rs/crate/pollster
+//! [VOICEVOX/voicevox_core#902]: https://github.com/VOICEVOX/voicevox_core/issues/902
+//! [`cpu_num_threads`]: crate::InitializeOptions::cpu_num_threads
 
 pub use crate::{
     engine::open_jtalk::nonblocking::OpenJtalk,

crates/voicevox_core/src/synthesizer.rs

@@ -97,6 +97,16 @@ pub enum AccelerationMode {
 #[derive(Default)]
 pub struct InitializeOptions {
     pub acceleration_mode: AccelerationMode,
+
+    /// CPU利用数を指定。0を指定すると環境に合わせたCPUが利用される。
+    ///
+    /// # Performance
+    ///
+    /// 未調査ではあるが、[非同期版API]においては物理コアの数+1とするのが適切な可能性がある
+    /// ([VOICEVOX/voicevox_core#902])。
+    ///
+    /// [非同期版API]: crate::nonblocking
+    /// [VOICEVOX/voicevox_core#902]: https://github.com/VOICEVOX/voicevox_core/issues/902
     pub cpu_num_threads: u16,
 }
 

crates/voicevox_core_python_api/python/voicevox_core/_rust/asyncio.pyi

@@ -157,7 +157,8 @@ class Synthesizer:
     acceleration_mode
         ハードウェアアクセラレーションモード。
     cpu_num_threads
-        CPU利用数を指定。0を指定すると環境に合わせたCPUが利用される。
+        CPU利用数を指定。0を指定すると環境に合わせたCPUが利用される。未調査ではあるが、物理コアの数+1とするのが適切な可能性がある
+        (`VOICEVOX/voicevox_core#902 <https://github.com/VOICEVOX/voicevox_core/issues/902>`_)。
     """
 
     def __init__(

crates/voicevox_core_python_api/python/voicevox_core/asyncio.py

@@ -1,3 +1,14 @@
+# TODO: Rust API同様に、`$BLOCKING_MAX_THREADS`について言及
+"""
+非同期API。
+
+Performance
+-----------
+
+未調査ではあるが、 ``cpu_num_threads`` 物理コアの数+1を指定するのが適切な可能性がある
+(`VOICEVOX/voicevox_core#902 <https://github.com/VOICEVOX/voicevox_core/issues/902>`_)。
+"""
+
 # pyright: reportMissingModuleSource=false
 from ._rust.asyncio import Onnxruntime, OpenJtalk, Synthesizer, UserDict, VoiceModelFile
 

crates/voicevox_core_python_api/python/voicevox_core/blocking.py

@@ -1,3 +1,5 @@
+# TODO: Rust API同様のmodule levelのdocstringを書く
+
 # pyright: reportMissingModuleSource=false
 from ._rust.blocking import (
     AudioFeature,