Atotti commited on
Commit
36e20ed
·
verified ·
1 Parent(s): f5a276a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +51 -174
README.md CHANGED
@@ -1,199 +1,76 @@
1
  ---
2
  library_name: transformers
3
- tags: []
4
  ---
5
 
6
- # Model Card for Model ID
7
 
8
- <!-- Provide a quick summary of what the model is/does. -->
9
 
 
10
 
 
11
 
12
- ## Model Details
13
 
14
- ### Model Description
15
 
16
- <!-- Provide a longer summary of what this model is. -->
17
 
18
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
 
 
 
19
 
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
 
28
- ### Model Sources [optional]
29
 
30
- <!-- Provide the basic links for the model. -->
 
 
 
31
 
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
 
36
- ## Uses
 
37
 
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
 
 
39
 
40
- ### Direct Use
41
 
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
 
44
- [More Information Needed]
 
 
 
 
45
 
46
- ### Downstream Use [optional]
 
47
 
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
 
50
- [More Information Needed]
 
 
 
51
 
52
- ### Out-of-Scope Use
 
 
 
 
 
 
 
 
 
 
 
53
 
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- [More Information Needed]
57
-
58
- ## Bias, Risks, and Limitations
59
-
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
-
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
-
70
- ## How to Get Started with the Model
71
-
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
-
76
- ## Training Details
77
-
78
- ### Training Data
79
-
80
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
-
103
- ## Evaluation
104
-
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
-
161
- [More Information Needed]
162
-
163
- #### Hardware
164
-
165
- [More Information Needed]
166
-
167
- #### Software
168
-
169
- [More Information Needed]
170
-
171
- ## Citation [optional]
172
-
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
-
175
- **BibTeX:**
176
-
177
- [More Information Needed]
178
-
179
- **APA:**
180
-
181
- [More Information Needed]
182
-
183
- ## Glossary [optional]
184
-
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
-
187
- [More Information Needed]
188
-
189
- ## More Information [optional]
190
-
191
- [More Information Needed]
192
-
193
- ## Model Card Authors [optional]
194
-
195
- [More Information Needed]
196
-
197
- ## Model Card Contact
198
-
199
- [More Information Needed]
 
1
  ---
2
  library_name: transformers
3
+ license: gemma
4
  ---
5
 
6
+ # google-usm: Extracted Gemma-3n Audio Encoder (USM)
7
 
8
+ ## モデル概要 (Model Description)
9
 
10
+ このモデルは、Googleのマルチモーダルモデル [`google/gemma-3n-e2b-it`](https://huggingface.co/google/gemma-3n-e2b-it) から、**音声エンコーダー部分 (`audio_tower`) のみ**を抽出したものです。
11
 
12
+ アーキテクチャは、論文 [Universal Speech Model](https://arxiv.org/abs/2303.01037) に基づく**Gemma3nAudioEncoder**です。
13
 
14
+ このエンコーダーは、音声波形データを受け取り、その内容を表現する高次元の特徴量(エンコーディング)のシーケンスに変換する役割を果たします。
15
 
16
+ ## 主な用途 (Intended Use)
17
 
18
+ このモデルは単体で音声認識(文字起こし)などを行うものではなく、より大きなモデルのコンポーネントとして使用されることを想定しています。
19
 
20
+ * **マルチモーダルモデルの音声入力部として**: 生成AIに音声情報を与えるための特徴量を抽出します。
21
+ * **音声分類**: このモデルの出力に分類ヘッドを追加して、特定の音声(例:笑い声、拍手、特定の単語)を分類するタスクでファインチューニングします。
22
+ * **音声類似度検索**: 音声のエンコーディングをベクトルとして扱い、意味的に似た音声を検索します。
23
+ * **話者認識**: 音声から話者を識別するタスクのベースモデルとして利用します。
24
 
25
+ ## 使用方法 (How to Use)
 
 
 
 
 
 
26
 
27
+ このモデル(音声エンコーダー)と、元モデルの`Feature Extractor`を組み合わせて使用します。
28
 
29
+ ```python
30
+ import torch
31
+ import soundfile as sf
32
+ from transformers import Gemma3nAudioEncoder, Gemma3nAudioFeatureExtractor
33
 
34
+ encoder_id = "Atotti/google-usm"
35
+ source_model_id = "google/gemma-3n-e2b-it"
 
36
 
37
+ audio_encoder = Gemma3nAudioEncoder.from_pretrained(encoder_id)
38
+ feature_extractor = Gemma3nAudioFeatureExtractor.from_pretrained(source_model_id)
39
 
40
+ device = "cuda" if torch.cuda.is_available() else "cpu"
41
+ audio_encoder.to(device)
42
+ audio_encoder.eval()
43
 
44
+ waveform, sampling_rate = sf.read("/home/audio/J-SpAW-release/ASV/F001_R1_E1_M1_AA.wav")
45
 
 
46
 
47
+ inputs = feature_extractor(
48
+ [waveform],
49
+ sampling_rate=sampling_rate,
50
+ return_tensors="pt"
51
+ )
52
 
53
+ audio_mel = inputs["input_features"].to(device)
54
+ audio_mel_mask = (inputs["input_features_mask"] == 0).to(device)
55
 
56
+ with torch.inference_mode():
57
 
58
+ audio_encodings, output_mask = audio_encoder(
59
+ audio_mel=audio_mel,
60
+ audio_mel_mask=audio_mel_mask
61
+ )
62
 
63
+ print(audio_encodings.shape) # torch.Size([1, 18, 1536])
64
+ print(audio_encodings[0, :5, :10])
65
+ # tensor([[ 0.0014, -0.0044, 0.0003, 0.0084, -0.0076, -0.0194, 0.0071, 0.0160,
66
+ # 0.0137, 0.0146],
67
+ # [-0.0153, 0.0051, 0.0111, -0.0134, -0.0032, -0.0134, 0.0112, -0.0163,
68
+ # 0.0050, 0.0036],
69
+ # [ 0.0003, -0.0022, 0.0164, -0.0090, -0.0033, -0.0043, 0.0030, -0.0042,
70
+ # -0.0060, 0.0066],
71
+ # [-0.0006, -0.0194, -0.0006, -0.0097, -0.0049, -0.0132, 0.0012, 0.0175,
72
+ # -0.0242, -0.0091],
73
+ # [ 0.0127, 0.0122, 0.0125, 0.0277, 0.0116, 0.0152, 0.0142, -0.0099,
74
+ # -0.0080, -0.0233]], device='cuda:0')
75
 
76
+ ```