hunarbatra commited on
Commit
1b2a3d8
·
verified ·
1 Parent(s): 19cd9d2

Update README with model/dataset documentation

Browse files
Files changed (1) hide show
  1. README.md +161 -199
README.md CHANGED
@@ -1,202 +1,164 @@
1
  ---
2
- library_name: transformers
3
- datasets:
4
- - OX-PIXL/STVQA-7K
5
- base_model:
6
- - Qwen/Qwen2.5-VL-7B-Instruct
 
 
 
 
 
 
7
  ---
8
 
9
- # Model Card for Model ID
10
-
11
- <!-- Provide a quick summary of what the model is/does. -->
12
-
13
-
14
-
15
- ## Model Details
16
-
17
- ### Model Description
18
-
19
- <!-- Provide a longer summary of what this model is. -->
20
-
21
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
22
-
23
- - **Developed by:** [More Information Needed]
24
- - **Funded by [optional]:** [More Information Needed]
25
- - **Shared by [optional]:** [More Information Needed]
26
- - **Model type:** [More Information Needed]
27
- - **Language(s) (NLP):** [More Information Needed]
28
- - **License:** [More Information Needed]
29
- - **Finetuned from model [optional]:** [More Information Needed]
30
-
31
- ### Model Sources [optional]
32
-
33
- <!-- Provide the basic links for the model. -->
34
-
35
- - **Repository:** [More Information Needed]
36
- - **Paper [optional]:** [More Information Needed]
37
- - **Demo [optional]:** [More Information Needed]
38
-
39
- ## Uses
40
-
41
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
42
-
43
- ### Direct Use
44
-
45
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
46
-
47
- [More Information Needed]
48
-
49
- ### Downstream Use [optional]
50
-
51
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
52
-
53
- [More Information Needed]
54
-
55
- ### Out-of-Scope Use
56
-
57
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
58
-
59
- [More Information Needed]
60
-
61
- ## Bias, Risks, and Limitations
62
-
63
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
64
-
65
- [More Information Needed]
66
-
67
- ### Recommendations
68
-
69
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
70
-
71
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
72
-
73
- ## How to Get Started with the Model
74
-
75
- Use the code below to get started with the model.
76
-
77
- [More Information Needed]
78
-
79
- ## Training Details
80
-
81
- ### Training Data
82
-
83
- <!-- 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. -->
84
-
85
- [More Information Needed]
86
-
87
- ### Training Procedure
88
-
89
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
90
-
91
- #### Preprocessing [optional]
92
-
93
- [More Information Needed]
94
-
95
-
96
- #### Training Hyperparameters
97
-
98
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
99
-
100
- #### Speeds, Sizes, Times [optional]
101
-
102
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
103
-
104
- [More Information Needed]
105
-
106
- ## Evaluation
107
-
108
- <!-- This section describes the evaluation protocols and provides the results. -->
109
-
110
- ### Testing Data, Factors & Metrics
111
-
112
- #### Testing Data
113
-
114
- <!-- This should link to a Dataset Card if possible. -->
115
-
116
- [More Information Needed]
117
-
118
- #### Factors
119
-
120
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
121
-
122
- [More Information Needed]
123
-
124
- #### Metrics
125
-
126
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
127
-
128
- [More Information Needed]
129
-
130
- ### Results
131
-
132
- [More Information Needed]
133
-
134
- #### Summary
135
-
136
-
137
-
138
- ## Model Examination [optional]
139
-
140
- <!-- Relevant interpretability work for the model goes here -->
141
-
142
- [More Information Needed]
143
-
144
- ## Environmental Impact
145
-
146
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
147
-
148
- 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).
149
-
150
- - **Hardware Type:** [More Information Needed]
151
- - **Hours used:** [More Information Needed]
152
- - **Cloud Provider:** [More Information Needed]
153
- - **Compute Region:** [More Information Needed]
154
- - **Carbon Emitted:** [More Information Needed]
155
-
156
- ## Technical Specifications [optional]
157
-
158
- ### Model Architecture and Objective
159
-
160
- [More Information Needed]
161
-
162
- ### Compute Infrastructure
163
-
164
- [More Information Needed]
165
-
166
- #### Hardware
167
-
168
- [More Information Needed]
169
-
170
- #### Software
171
-
172
- [More Information Needed]
173
-
174
- ## Citation [optional]
175
-
176
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
177
-
178
- **BibTeX:**
179
-
180
- [More Information Needed]
181
-
182
- **APA:**
183
-
184
- [More Information Needed]
185
-
186
- ## Glossary [optional]
187
-
188
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
189
-
190
- [More Information Needed]
191
-
192
- ## More Information [optional]
193
-
194
- [More Information Needed]
195
-
196
- ## Model Card Authors [optional]
197
-
198
- [More Information Needed]
199
-
200
- ## Model Card Contact
201
-
202
- [More Information Needed]
 
1
  ---
2
+ license: apache-2.0
3
+ language:
4
+ - en
5
+ tags:
6
+ - spatial-reasoning
7
+ - multimodal
8
+ - vision-language
9
+ - scene-graph
10
+ - reinforcement-learning
11
+ base_model: Qwen/Qwen2.5-VL-7B-Instruct
12
+ pipeline_tag: image-text-to-text
13
  ---
14
 
15
+ # SpatialThinker-7B
16
+
17
+ <p align="center">
18
+ <a href="https://arxiv.org/abs/2511.07403">
19
+ <img src="https://img.shields.io/badge/arXiv-2511.07403-b31b1b.svg" alt="arXiv">
20
+ </a>
21
+ <a href="https://hunarbatra.com/SpatialThinker">
22
+ <img src="https://img.shields.io/badge/🌐%20Project%20Page-blue.svg" alt="Project Page">
23
+ </a>
24
+ <a href="https://github.com/hunarbatra/SpatialThinker">
25
+ <img src="https://img.shields.io/badge/GitHub-Repository-black.svg" alt="GitHub">
26
+ </a>
27
+ </p>
28
+
29
+ **SpatialThinker-7B** is a 3D-aware multimodal large language model (MLLM) trained with reinforcement learning to integrate structured spatial grounding with multi-step reasoning. The model simulates human-like spatial perception by constructing a scene graph of task-relevant objects and spatial relations, and reasoning towards an answer via dense spatial rewards.
30
+
31
+ ## Model Description
32
+
33
+ - **Base Model**: Qwen2.5-VL-7B-Instruct
34
+ - **Training**: GRPO (Group Relative Policy Optimization) with dense spatial rewards
35
+ - **Training Data**: STVQA-7K (7,587 spatial VQA samples)
36
+ - **Authors**: Hunar Batra, Haoqin Tu, Hardy Chen, Yuanze Lin, Cihang Xie, Ronald Clark
37
+ - **Institutions**: University of Oxford, UC Santa Cruz
38
+
39
+ ## Key Features
40
+
41
+ - **Structured Spatial Reasoning**: Constructs question-focused scene subgraphs with objects, bounding boxes, and relations
42
+ - **Dense Spatial Rewards**: Multi-objective reward function enforcing format, count, accuracy, and spatial grounding
43
+ - **9 Spatial Reasoning Categories**: Relations, reach, size, orientation, instance location, depth, distance, count, and existence
44
+ - **Outperforms GPT-4o**: On spatial understanding benchmarks while using only 7K training samples
45
+
46
+ ## Inference Template
47
+
48
+ Use the following template for inference:
49
+
50
+ ```
51
+ You FIRST observe the image in <observe> </observe> tags, then visualise the relevant scene graph in <scene> </scene> tags, followed by thinking about the reasoning process as an internal monologue within <think> </think> tags and then provide the final answer. The final answer MUST BE put within <answer> </answer> tags, and only return the final choice including the correct option and answer within the answer tags, e.g., <answer> (A) cat </answer>.
52
+
53
+ Image size: {Width} x {Height}
54
+ ```
55
+
56
+ ## Output Format
57
+
58
+ The model generates structured output with four components:
59
+
60
+ 1. **`<observe>`**: Scene description covering relevant objects
61
+ 2. **`<scene>`**: JSON scene graph with objects (id, bbox) and relationships (subject, predicate, object)
62
+ 3. **`<think>`**: Step-by-step reasoning as internal monologue
63
+ 4. **`<answer>`**: Final answer with option letter and text
64
+
65
+ ### Example Output
66
+
67
+ ```
68
+ <observe>
69
+ The image shows a living room with a couch, a coffee table, and a cat sitting on the floor.
70
+ </observe>
71
+ <scene>
72
+ {
73
+ "objects": [
74
+ {"id": "couch.1", "bbox": [50, 100, 400, 350]},
75
+ {"id": "cat.1", "bbox": [200, 300, 280, 400]},
76
+ {"id": "table.1", "bbox": [150, 250, 350, 320]}
77
+ ],
78
+ "relationships": [
79
+ {"subject": "cat.1", "predicate": "in front of", "object": "couch.1"},
80
+ {"subject": "cat.1", "predicate": "beside", "object": "table.1"}
81
+ ]
82
+ }
83
+ </scene>
84
+ <think>
85
+ Looking at the scene graph, the cat is positioned in front of the couch and beside the coffee table. The bounding box coordinates show the cat is at y=300-400 while the couch extends to y=350, confirming the cat is on the floor in front of the couch.
86
+ </think>
87
+ <answer> (B) in front of the couch </answer>
88
+ ```
89
+
90
+ ## Usage
91
+
92
+ ```python
93
+ from transformers import Qwen2_5_VLForConditionalGeneration, AutoProcessor
94
+ from PIL import Image
95
+
96
+ model = Qwen2_5_VLForConditionalGeneration.from_pretrained(
97
+ "OX-PIXL/SpatialThinker-7B",
98
+ torch_dtype="auto",
99
+ device_map="auto"
100
+ )
101
+ processor = AutoProcessor.from_pretrained("OX-PIXL/SpatialThinker-7B")
102
+
103
+ # Load image
104
+ image = Image.open("your_image.jpg")
105
+ width, height = image.size
106
+
107
+ # Prepare prompt with template
108
+ template = f"""You FIRST observe the image in <observe> </observe> tags, then visualise the relevant scene graph in <scene> </scene> tags, followed by thinking about the reasoning process as an internal monologue within <think> </think> tags and then provide the final answer. The final answer MUST BE put within <answer> </answer> tags, and only return the final choice including the correct option and answer within the answer tags, e.g., <answer> (A) cat </answer>.
109
+
110
+ Image size: {width} x {height}"""
111
+
112
+ question = "Where is the cat relative to the couch? (A) on top of (B) in front of (C) behind (D) beside"
113
+
114
+ messages = [
115
+ {
116
+ "role": "user",
117
+ "content": [
118
+ {"type": "image", "image": image},
119
+ {"type": "text", "text": template + "\n\n" + question},
120
+ ],
121
+ }
122
+ ]
123
+
124
+ text = processor.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
125
+ inputs = processor(text=[text], images=[image], return_tensors="pt").to(model.device)
126
+
127
+ generated_ids = model.generate(**inputs, max_new_tokens=1024)
128
+ output = processor.batch_decode(generated_ids, skip_special_tokens=True)[0]
129
+ print(output)
130
+ ```
131
+
132
+ ## Evaluation Results
133
+
134
+ SpatialThinker-7B achieves state-of-the-art performance on spatial reasoning benchmarks:
135
+
136
+ | Benchmark | SpatialThinker-7B |
137
+ |-----------|------------------------|
138
+ | CV-Bench (3D) | Strong performance |
139
+ | BLINK-Spatial | Outperforms GPT-4o |
140
+ | SpatialBench | SOTA results |
141
+ | RealWorldQA | Competitive |
142
+
143
+ See the [paper](https://arxiv.org/abs/2511.07403) for detailed results.
144
+
145
+ ## Citation
146
+
147
+ ```bibtex
148
+ @misc{batra2025spatialthinkerreinforcing3dreasoning,
149
+ title={SpatialThinker: Reinforcing 3D Reasoning in Multimodal LLMs via Spatial Rewards},
150
+ author={Hunar Batra and Haoqin Tu and Hardy Chen and Yuanze Lin and Cihang Xie and Ronald Clark},
151
+ year={2025},
152
+ eprint={2511.07403},
153
+ archivePrefix={arXiv},
154
+ primaryClass={cs.CV},
155
+ url={https://arxiv.org/abs/2511.07403},
156
+ }
157
+ ```
158
+
159
+ ## Links
160
+
161
+ - 📄 **Paper**: [arXiv:2511.07403](https://arxiv.org/abs/2511.07403)
162
+ - 🌐 **Project Page**: [hunarbatra.com/SpatialThinker](https://hunarbatra.com/SpatialThinker)
163
+ - 💻 **GitHub**: [github.com/hunarbatra/SpatialThinker](https://github.com/hunarbatra/SpatialThinker)
164
+ - 🤗 **Dataset**: [OX-PIXL/STVQA-7K](https://huggingface.co/datasets/OX-PIXL/STVQA-7K)