From d3418f1cff3d227398f5def61ecd95f73483538c Mon Sep 17 00:00:00 2001
From: laurent <laurent.mazare@gmail.com>
Date: Thu, 6 Jul 2023 07:57:03 +0100
Subject: [PATCH] Add the original whisper names as comment.

---
 candle-examples/examples/whisper/model.rs | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)

diff --git a/candle-examples/examples/whisper/model.rs b/candle-examples/examples/whisper/model.rs
index 4b3cfc7a..3de150d6 100644
--- a/candle-examples/examples/whisper/model.rs
+++ b/candle-examples/examples/whisper/model.rs
@@ -77,18 +77,20 @@ impl HiddenAct {
     }
 }
 
+// The names in comments correspond to the original implementation:
+// https://github.com/openai/whisper/blob/f572f2161ba831bae131364c3bffdead7af6d210/whisper/model.py#L17
 #[derive(Debug, Clone, PartialEq, Deserialize)]
 pub struct Config {
-    pub num_mel_bins: usize,
-    pub max_source_positions: usize,
-    pub d_model: usize,
-    pub encoder_attention_heads: usize,
-    pub encoder_layers: usize,
-    pub vocab_size: usize,
-    pub max_target_positions: usize,
+    pub num_mel_bins: usize,            // n_mels
+    pub max_source_positions: usize,    // n_audio_ctx
+    pub d_model: usize,                 // n_audio_state
+    pub encoder_attention_heads: usize, // n_audio_head
+    pub encoder_layers: usize,          // n_audio_layer
+    pub vocab_size: usize,              // n_vocab
+    pub max_target_positions: usize,    //  n_text_ctx
     // pub n_text_state: usize,
-    pub decoder_attention_heads: usize,
-    pub decoder_layers: usize,
+    pub decoder_attention_heads: usize, // n_text_head
+    pub decoder_layers: usize,          // n_text_layer
 }
 
 impl Config {