Update README with model/dataset documentation

#2
by hunarbatra - opened
Files changed (1) hide show
  1. README.md +161 -200
README.md CHANGED
@@ -1,203 +1,164 @@
1
  ---
2
- datasets:
3
- - OX-PIXL/STVQA-7K
4
- base_model:
5
- - Qwen/Qwen2.5-VL-7B-Instruct
 
 
 
 
 
 
 
6
  ---
7
 
8
- Paper: https://arxiv.org/abs/2511.07403
9
-
10
- # Model Card for Model ID
11
-
12
- <!-- Provide a quick summary of what the model is/does. -->
13
-
14
-
15
-
16
- ## Model Details
17
-
18
- ### Model Description
19
-
20
- <!-- Provide a longer summary of what this model is. -->
21
-
22
- This is the model card of a ๐Ÿค— transformers model that has been pushed on the Hub. This model card has been automatically generated.
23
-
24
- - **Developed by:** [More Information Needed]
25
- - **Funded by [optional]:** [More Information Needed]
26
- - **Shared by [optional]:** [More Information Needed]
27
- - **Model type:** [More Information Needed]
28
- - **Language(s) (NLP):** [More Information Needed]
29
- - **License:** [More Information Needed]
30
- - **Finetuned from model [optional]:** [More Information Needed]
31
-
32
- ### Model Sources [optional]
33
-
34
- <!-- Provide the basic links for the model. -->
35
-
36
- - **Repository:** [More Information Needed]
37
- - **Paper [optional]:** [More Information Needed]
38
- - **Demo [optional]:** [More Information Needed]
39
-
40
- ## Uses
41
-
42
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
43
-
44
- ### Direct Use
45
-
46
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
47
-
48
- [More Information Needed]
49
-
50
- ### Downstream Use [optional]
51
-
52
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
53
-
54
- [More Information Needed]
55
-
56
- ### Out-of-Scope Use
57
-
58
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
59
-
60
- [More Information Needed]
61
-
62
- ## Bias, Risks, and Limitations
63
-
64
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
65
-
66
- [More Information Needed]
67
-
68
- ### Recommendations
69
-
70
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
71
-
72
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
73
-
74
- ## How to Get Started with the Model
75
-
76
- Use the code below to get started with the model.
77
-
78
- [More Information Needed]
79
-
80
- ## Training Details
81
-
82
- ### Training Data
83
-
84
- <!-- 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. -->
85
-
86
- [More Information Needed]
87
-
88
- ### Training Procedure
89
-
90
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
91
-
92
- #### Preprocessing [optional]
93
-
94
- [More Information Needed]
95
-
96
-
97
- #### Training Hyperparameters
98
-
99
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
100
-
101
- #### Speeds, Sizes, Times [optional]
102
-
103
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
104
-
105
- [More Information Needed]
106
-
107
- ## Evaluation
108
-
109
- <!-- This section describes the evaluation protocols and provides the results. -->
110
-
111
- ### Testing Data, Factors & Metrics
112
-
113
- #### Testing Data
114
-
115
- <!-- This should link to a Dataset Card if possible. -->
116
-
117
- [More Information Needed]
118
-
119
- #### Factors
120
-
121
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
122
-
123
- [More Information Needed]
124
-
125
- #### Metrics
126
-
127
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
128
-
129
- [More Information Needed]
130
-
131
- ### Results
132
-
133
- [More Information Needed]
134
-
135
- #### Summary
136
-
137
-
138
-
139
- ## Model Examination [optional]
140
-
141
- <!-- Relevant interpretability work for the model goes here -->
142
-
143
- [More Information Needed]
144
-
145
- ## Environmental Impact
146
-
147
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
148
-
149
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in Lacoste et al. (2019).
150
-
151
- - **Hardware Type:** [More Information Needed]
152
- - **Hours used:** [More Information Needed]
153
- - **Cloud Provider:** [More Information Needed]
154
- - **Compute Region:** [More Information Needed]
155
- - **Carbon Emitted:** [More Information Needed]
156
-
157
- ## Technical Specifications [optional]
158
-
159
- ### Model Architecture and Objective
160
-
161
- [More Information Needed]
162
-
163
- ### Compute Infrastructure
164
-
165
- [More Information Needed]
166
-
167
- #### Hardware
168
-
169
- [More Information Needed]
170
-
171
- #### Software
172
-
173
- [More Information Needed]
174
-
175
- ## Citation [optional]
176
-
177
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
178
-
179
- **BibTeX:**
180
-
181
- [More Information Needed]
182
-
183
- **APA:**
184
-
185
- [More Information Needed]
186
-
187
- ## Glossary [optional]
188
-
189
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
190
-
191
- [More Information Needed]
192
-
193
- ## More Information [optional]
194
-
195
- [More Information Needed]
196
-
197
- ## Model Card Authors [optional]
198
-
199
- [More Information Needed]
200
-
201
- ## Model Card Contact
202
-
203
- [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)