Update README.md

README.md

@@ -1,199 +1,132 @@
 ---
-library_name: transformers
-tags: []
+tags:
+- audio
+- audio-language
+- multimodal
+- reasoning
+- auditory-semantics
+- reinforcement-learning
+- grpo
+- qwen
+- audsem
+- question-answering
+- qa
+language: en
+license: apache-2.0
+datasets:
+- GLJS/AudSem
 ---
 
-# Model Card for Model ID
-
-<!-- Provide a quick summary of what the model is/does. -->
-
-
-
-## Model Details
-
-### Model Description
-
-<!-- Provide a longer summary of what this model is. -->
-
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-
-### Model Sources [optional]
-
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-
-## Uses
-
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
-### Direct Use
-
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
-[More Information Needed]
-
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
-
-[More Information Needed]
-
-## Training Details
-
-### Training Data
-
-<!-- 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. -->
-
-[More Information Needed]
-
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-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).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Model Card Authors [optional]
-
-[More Information Needed]
-
-## Model Card Contact
-
-[More Information Needed]
+# AudSemThinker-QA-GRPO
+
+## Model Description
+`AudSemThinker-QA-GRPO` is an advanced variant of `AudSemThinker`, fine-tuned using Group Relative Policy Optimization (GRPO) with Verifiable Rewards (RLVR). This approach enhances reasoning capabilities and allows for controlled thinking budget during generation. It leverages the structured reasoning framework of `AudSemThinker` (thinking, semantic elements, answer phases) but is specifically optimized for multiple-choice audio question answering. This model is designed to produce accurate answers while maintaining a controlled reasoning length in its `<think>` section.
+
+## How to Use
+To use `AudSemThinker-QA-GRPO` for audio question answering, you can load it using the `transformers` library. Ensure you have `torch`, `torchaudio`, and `soundfile` installed.
+
+```python
+from transformers import AutoProcessor, AutoModelForCausalLM
+import torch
+import torchaudio
+import soundfile as sf
+
+# Load processor and model
+processor = Qwen2_5OmniProcessor.from_pretrained("GLJS/audsemthinker-qa-grpo", trust_remote_code=True)
+model = Qwen2_5OmniThinkerForConditionalGeneration.from_pretrained(
+    "GLJS/audsemthinker-qa-grpo",
+    torch_dtype=torch.bfloat16,
+    device_map="auto",
+    trust_remote_code=True,
+    low_cpu_mem_usage=True,
+)
+
+# Example audio file (replace with your audio path)
+audio_file = "path/to/your/audio.wav"
+
+audio_input, sampling_rate = torchaudio.load(audio_file)
+if sampling_rate != processor.feature_extractor.sampling_rate:
+    audio_input = torchaudio.transforms.Resample(orig_freq=sampling_rate, new_freq=processor.feature_extractor.sampling_rate)(audio_input)
+audio_input = audio_input.squeeze().numpy() # Ensure mono and numpy array
+
+# Example multiple-choice question
+question = "What type of sound is present in the audio? Options: (A) Speech (B) Music (C) Environmental Sound (D) Silence"
+user_prompt_text = f"You are given a question and an audio clip. Your task is to answer the question based on the audio clip. First, think about the question and the audio clip and put your thoughts in <think> and </think> tags. Then reason about the semantic elements involved in the audio clip and put your reasoning in <semantic_elements> and </semantic_elements> tags. Then answer the question based on the audio clip, put your answer in <answer> and </answer> tags.\nQuestion: {question}"
+
+# Construct messages in conversation format, similar to training
+messages = [
+    {"role": "system", "content": [{"type": "text", "text": "You are Qwen, a virtual human developed by the Qwen Team, Alibaba Group, capable of perceiving auditory and visual inputs, as well as generating text and speech."}]},
+    {
+        "role": "user",
+        "content": [
+            {"type": "audio", "audio": audio_input},
+            {"type": "text", "text": user_prompt_text}
+        ]
+    }
+]
+
+# Apply chat template
+text_from_chat_template = processor.apply_chat_template(
+    messages,
+    tokenize=False,
+    add_generation_prompt=True
+)
+
+# Prepare inputs for the model
+inputs = processor(
+    text=text_from_chat_template,
+    audio=[audio_input], # Pass audio as a list of numpy arrays
+    return_tensors="pt"
+).to(model.device)
+
+# Generate response
+output_ids = model.generate(**inputs, max_new_tokens=512)
+response = processor.batch_decode(output_ids, skip_special_tokens=True)[0]
+
+print(response)
+# Expected output format for QA:
+# <think>...detailed reasoning about the audio scene and question...</think>
+# <semantic_elements>...list of identified semantic descriptors...</semantic_elements>
+# <answer>...selected option (e.g., (B) Music)...</answer>
+```
+
+## Training Data
+`AudSemThinker-QA-GRPO` is fine-tuned on the **multiple-choice Question Answering (QA) subset** of the `AudSem` dataset (approximately 140k examples). This subset provides easily verifiable correct answers, making it suitable for Reinforcement Learning with Verifiable Rewards (RLVR).
+
+## Training Procedure
+*   **Base Model:** Qwen2.5-Omni-7B.
+*   **Fine-tuning Paradigm:** Reinforcement Learning with Group Relative Policy Optimization (GRPO).
+*   **Reward Functions:**
+    *   **Accuracy Reward:** Evaluates the correctness of the content within the `<answer>` tags using string matching for multiple-choice questions.
+    *   **Format Adherence Reward:** Encourages strict adherence to the prescribed XML-tag structure (`<think>`, `<semantic_elements>`, `<answer>`), checking for presence, correct order, and proper encapsulation.
+    *   **Length Constraint Reward:** Specifically targets the `<think>` phase, penalizing deviations from a target thinking length (25 words for this model) to promote controlled reasoning budget.
+*   **Parameter-Efficient Fine-tuning:** LoRA (Low-Rank Adaptation).
+*   **GRPO Loss Type:** Default with `beta = 0.01`.
+*   **Generations per prompt (k):** 6.
+*   **Precision:** bf16.
+*   **Batch Size:** 2 per device.
+*   **Hardware:** Trained on four H100 GPUs, utilizing DeepSpeed ZeRO-3 and vLLM for efficient training and inference.
+*   **Training Time:** Approximately 10 hours.
+
+## Evaluation Results
+`AudSemThinker-QA-GRPO` demonstrates strong performance on multiple-choice QA tasks, showcasing the effectiveness of GRPO in guiding the model towards desired reasoning patterns and controlled thinking lengths.
+
+## Limitations and Bias
+*   **Generalization to Open-Ended Tasks:** While GRPO is effective for multiple-choice QA, its performance on open-ended tasks like general audio captioning or free-form QA may not always surpass SFT, as verifying the quality of longer, more subjective generated text is more challenging for automated reward models.
+*   **Thinking Budget Sensitivity:** The effectiveness of the length constraint reward can depend on parameters (`alpha`, `delta`) and the initial average output length of the model. Excessively long target reasoning phases, if they fall outside the effective reward range, may not translate to better performance under the current setup.
+*   **Data Contamination:** While `AudSem` is designed to minimize overlap, the underlying `Qwen2.5-Omni` pretrained model might have encountered data present in test sets during its initial pretraining.
+
+## Ethical Considerations
+*   **Data Sourcing:** The `AudSem` dataset is primarily sourced from YouTube closed captions. While systematic checks for harmful content (e.g., child abuse, hate speech, sexual content, harassment) were performed and YouTube's community guidelines provide a safeguard, inherent biases or problematic content from the original video sources could potentially be present.
+*   **Societal Impact:** `AudSemThinker-QA-GRPO` can contribute to positive societal impacts by enhancing audio-language understanding, particularly in scenarios requiring precise and controlled question answering from audio, potentially leading to more reliable automated systems.
+
+## Citation
+```bibtex
+@article{wijngaard2025audsemthinker,
+  title={AudSemThinker: Enhancing Audio-Language Models through Reasoning over Semantics of Sound},
+  author={Wijngaard, Gijs and Formisano, Elia and Esposito, Michele and Dumontier, Michel},
+  journal={NeurIPS},
+  year={2025},
+  url={https://github.com/GLJS/AudSemThinker}
+}
+```