docを追記

VOICEVOX · Nov 15, 2023 · a73f22c · a73f22c
1 parent 1655719
commit a73f22c
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 3 deletions.
diff --git a/crates/voicevox_core/src/infer.rs b/crates/voicevox_core/src/infer.rs
@@ -36,10 +36,16 @@ pub(crate) trait InferenceRuntime: 'static {
     fn run(ctx: Self::RunContext<'_>) -> anyhow::Result<Vec<OutputTensor>>;
 }
 
+/// `VoiceModel`に対応する、
 pub(crate) trait InferenceDomain {
     type Operation: InferenceOperation;
 }
 
+/// `InferenceDomain`の推論操作を表す列挙型。
+///
+/// それぞれのバリアントには、対応する`InferenceSignature`が存在するべきである。
+///
+/// `::macros::InferenceOperation`により導出される。
 pub(crate) trait InferenceOperation: Copy + Enum {
     /// `{InferenceInputSignature,InferenceOutputSignature}::PARAM_INFOS`を集めたもの。
     ///
@@ -54,13 +60,19 @@ pub(crate) trait InferenceOperation: Copy + Enum {
     >;
 }
 
+/// `InferenceDomain`の推論操作を表す列挙型。
+///
+/// `::macros::InferenceOperation`により、具体型ごと生成される。
 pub(crate) trait InferenceSignature: Sized + Send + 'static {
     type Domain: InferenceDomain;
     type Input: InferenceInputSignature<Signature = Self>;
     type Output: InferenceOutputSignature;
     const OPERATION: <Self::Domain as crate::infer::InferenceDomain>::Operation;
 }
 
+/// 推論操作の入力シグネチャ。
+///
+/// `::macros::InferenceInputSignature`により導出される。
 pub(crate) trait InferenceInputSignature: Send + 'static {
     type Signature: InferenceSignature<Input = Self>;
     const PARAM_INFOS: &'static [ParamInfo<InputScalarKind>];
@@ -88,6 +100,9 @@ pub(crate) enum InputScalarKind {
     Float32,
 }
 
+/// 推論操作の出力シグネチャ。
+///
+/// `::macros::InferenceOutputSignature`により、`TryFrom`も含めて導出される。
 pub(crate) trait InferenceOutputSignature:
     TryFrom<Vec<OutputTensor>, Error = anyhow::Error> + Send
 {

diff --git a/crates/voicevox_core_macros/src/lib.rs b/crates/voicevox_core_macros/src/lib.rs
@@ -4,7 +4,12 @@ mod inference_domain;
 
 use syn::parse_macro_input;
 
-/// Rust APIクレート内で、`crate::infer::InferenceDomain`を実装する。
+/// Rust APIクレート内で、`crate::infer::InferenceDomain`の導出などを行う。
+///
+/// 次のことを行う。
+///
+/// - `InferenceDomain`の導出
+/// - 各バリアントに対する`InferenceInputSignature`の実装を、型ごと生成
 ///
 /// # Example
 ///
@@ -49,7 +54,7 @@ pub fn derive_inference_operation(input: proc_macro::TokenStream) -> proc_macro:
     from_syn(inference_domain::derive_inference_operation(input))
 }
 
-/// Rust APIクレート内で、`crate::infer::InferenceInputSignature`を実装する。
+/// Rust APIクレート内で、`crate::infer::InferenceInputSignature`を導出する。
 ///
 /// # Example
 ///
@@ -72,7 +77,8 @@ pub fn derive_inference_input_signature(input: proc_macro::TokenStream) -> proc_
     from_syn(inference_domain::derive_inference_input_signature(input))
 }
 
-/// Rust APIクレート内で、`crate::infer::InferenceInputSignature`を実装する。
+/// Rust APIクレート内で`crate::infer::InferenceInputSignature`を、`TryFrom<OutputTensor>`ごと導出
+/// する。
 ///
 /// # Example
 ///