Blinorot commited on
Commit
068dee4
·
verified ·
1 Parent(s): 5d91e82

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +140 -195
README.md CHANGED
@@ -1,199 +1,144 @@
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
+ datasets:
4
+ - Blinorot/ALARM-Corpora
5
+ base_model:
6
+ - Qwen/Qwen3-4B-Thinking-2507
7
  ---
8
 
9
+ # Model Card for AL-Whisper-Instruct-R
10
+
11
+ This is a checkpoint for AL-Whisper-Instruct-R, audio-understanding reasoning language model, proposed in [ALARM: Audio–Language Alignment for Reasoning Models](https://arxiv.org/abs/2603.09556).
12
+ This model is trained only on the speech instruction subset of the data.
13
+
14
+ Can be combined with [ALARM-CA](https://huggingface.co/Blinorot/ALARM-CA) to create ALARM-E model that achieves state-of-the-art performance (the best open-source, the third overall) on [MMSU](https://arxiv.org/abs/2506.04779) and [MMAU-Speech](https://arxiv.org/abs/2410.19168) benchmarks.
15
+
16
+ For more details regarding the model and its usage, please refer to our [GitHub](https://github.com/Blinorot/ALARM).
17
+
18
+ ## Inference
19
+
20
+ We provide [vLLM](https://github.com/vllm-project/vllm) support using [vLLM Prompt Embedding API](https://docs.vllm.ai/en/stable/features/prompt_embeds/).
21
+ Since ALARM uses the frozen Qwen3 model as the backbone, `vllm` just runs the original Qwen3 checkpoint, and the ALARM checkpoint is used for extracting LLM input embeddings.
22
+ After you cloned the repo and installed the depnedencies, you can run the pretrained model as follows:
23
+
24
+ ```python
25
+ # Import libraries
26
+ import os
27
+ os.environ["CUDA_VISIBLE_DEVICES"] = "0" #optional
28
+
29
+ # run before importing torch because generate_vllm sets the multiprocessing method
30
+ from generate_vllm import get_response
31
+ from src.model.wrapped_llms.qwen3 import Qwen3AudioWrappedFeatureExtractor
32
+
33
+ from omegaconf import OmegaConf
34
+ from torchaudio.utils import _download_asset
35
+ from torchcodec.decoders import AudioDecoder
36
+ from transformers import AutoTokenizer
37
+ from vllm import LLM
38
+
39
+
40
+ # The model configuration config.
41
+ # Handles vllm-related configuration and defines feature extractors,
42
+ # i.e., audio -> encoder input embedding conversion.
43
+ # All other configuration, including model architecture, will be
44
+ # loaded from the checkpoint.
45
+ default_model_config_name = "src/configs/model/default_inference.yaml"
46
+ model_config = OmegaConf.load(default_model_config_name)
47
+
48
+ # checkpoint_name = which model to run
49
+ # Single model version (no inference-time ensemble):
50
+ # checkpoint_name='Blinorot/AL-Whisper-Instruct-R'
51
+ # ALARM-E embedding fusion-type version (inference-time ensemble):
52
+ # checkpoint_name=["Blinorot/ALARM-CA","Blinorot/AL-Whisper-Instruct-R"]
53
+ checkpoint_name = "Blinorot/AL-Whisper-Instruct-R"
54
+
55
+ device = "cuda"
56
+
57
+ # Load Tokenizer for Text Processing
58
+ tokenizer = AutoTokenizer.from_pretrained(model_config.llm)
59
+
60
+ # Load ALARM/AL-*-R checkpoints for extraction of LLM input embeddings
61
+ if isinstance(checkpoint_name, list): # ALARM-E-style embedding fusion (inference-time ensemble)
62
+ feature_extractor_list = []
63
+ for name in checkpoint_name:
64
+ # Load weights into the (audio,text)->LLM embeddings converter
65
+ feature_extractor = Qwen3AudioWrappedFeatureExtractor(
66
+ model_config=model_config,
67
+ checkpoint_name=name,
68
+ tokenizer=tokenizer,
69
+ )
70
+ feature_extractor.to(device)
71
+ feature_extractor_list.append(feature_extractor)
72
+ feature_extractor = feature_extractor_list
73
+ else: # Single Model version (no inference-time ensemble)
74
+ # Load weights into the (audio,text)->LLM embeddings converter
75
+ feature_extractor = Qwen3AudioWrappedFeatureExtractor(
76
+ model_config=model_config,
77
+ checkpoint_name=checkpoint_name,
78
+ tokenizer=tokenizer,
79
+ )
80
+ feature_extractor.to(device)
81
+
82
+ # Start the offline vLLM instance of original Qwen3 RLM
83
+ # Model will be loaded to CUDA_VISIBLE_DEVICES id
84
+ llm = LLM(
85
+ model_config.llm,
86
+ enable_prefix_caching=True,
87
+ max_model_len=model_config.max_model_len,
88
+ max_num_seqs=model_config.max_num_seq,
89
+ max_num_batched_tokens=model_config.max_num_batched_tokens,
90
+ gpu_memory_utilization=model_config.gpu_memory_utilization,
91
+ enable_prompt_embeds=True,
92
+ )
93
+
94
+ # Set sampling arguments for the RLM
95
+ sample = llm.get_default_sampling_params()
96
+ sample.seed = model_config.seed
97
+ sample.max_tokens = model_config.max_tokens
98
+
99
+ # Define audio and prompt
100
+ # Audio must come from torchcodec.AudioDecoder
101
+ audio_example_path = _download_asset("tutorial-assets/ctc-decoding/1688-142285-0007.wav")
102
+ audio = AudioDecoder(audio_example_path)
103
+ prompt = "Describe the audio content."
104
+
105
+ # Define a system prompt
106
+ system_prompt = "You are an audio-understanding model."
107
+
108
+ # Obtain response from Audio RLM
109
+ response = get_response(
110
+ prompts=[prompt], # list of all the prompts
111
+ audio_list=[audio], # list of corresponding audio
112
+ llm=llm,
113
+ feature_extractor=feature_extractor,
114
+ sample=sample,
115
+ tokenizer=tokenizer,
116
+ system_prompt=system_prompt,
117
+ max_thinking_tokens=model_config.max_thinking_tokens, # controls thinking budget for the RLM
118
+ debug=False,
119
+ )
120
+
121
+ # Response is a list of responses, one per each (prompt, audio) input pair
122
+ # We have only one input pair, so the final response is at index 0
123
+ response = response[0]
124
+
125
+ print(f"Model response:\n\n{response}")
126
+ ```
127
+
128
+ ## Citation
129
+
130
+ If you use this work, please cite:
131
+
132
+ ```bibtex
133
+ @article{grinberg2026alarm,
134
+ title={ALARM: Audio-Language Alignment for Reasoning Models},
135
+ author={Grinberg, Petr and Shahmohammadi, Hassan},
136
+ journal={arXiv preprint arXiv:2603.09556},
137
+ year={2026}
138
+ }
139
+ ```
140
+
141
+ ## License
142
+
143
+ The model checkpoint is licensed under Creative Commons Attribution-NonCommercial 4.0 (CC BY-NC 4.0).
144
+ It may only be used for non-commercial research purposes.