Enhance model card with metadata, links, and usage example

#1
by nielsr HF Staff - opened
Files changed (1) hide show
  1. README.md +75 -0
README.md ADDED
@@ -0,0 +1,75 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: mit
3
+ pipeline_tag: image-text-to-text
4
+ library_name: transformers
5
+ ---
6
+
7
+ # CodePlot-CoT: Mathematical Visual Reasoning by Thinking with Code-Driven Images
8
+
9
+ <div align="center">
10
+ <a href="https://math-vr.github.io"><img src="https://img.shields.io/badge/Project-Homepage-green" alt="Home"></a>
11
+ <a href="https://huggingface.co/papers/2510.11718"><img src="https://img.shields.io/badge/Paper-red" alt="Paper"></a>
12
+ <a href="https://github.com/HKU-MMLab/Math-VR-CodePlot-CoT"><img src="https://img.shields.io/badge/GitHub-Code-keygen.svg?logo=github&style=flat-square" alt="GitHub"></a>
13
+ </div>
14
+
15
+ This repository contains the **CodePlot-CoT** model, a core component of the paper [CodePlot-CoT: Mathematical Visual Reasoning by Thinking with Code-Driven Images](https://huggingface.co/papers/2510.11718).
16
+ CodePlot-CoT is an innovative code-driven Chain-of-Thought (CoT) paradigm designed to enable Vision Language Models (VLMs) to "think with images" when solving mathematical problems. Instead of generating pixel-based images directly, the model outputs executable plotting code to represent its "visual thoughts". This code is then executed to render a precise figure, which is reinput to the model as a visual input for subsequent reasoning steps.
17
+
18
+ The model is built upon the Qwen2.5-VL architecture and is compatible with the `transformers` library.
19
+
20
+ <div align="center">
21
+ Β  <img src="https://github.com/HKU-MMLab/Math-VR-CodePlot-CoT/raw/main/figures/teaser.png" width="100%"/>
22
+ </div>
23
+
24
+ ## Sample Usage
25
+
26
+ ### Installation
27
+ To get started with CodePlot-CoT, clone the repository and install the required packages:
28
+
29
+ ```bash
30
+ conda create -n codeplot python==3.10
31
+ conda activate codeplot
32
+ git clone [email protected]:HKU-MMLab/Math-VR-CodePlot-CoT.git
33
+ cd CodePlot-CoT
34
+ pip install -r requirements.txt
35
+ pip install flash_attn==2.7.4.post1
36
+ ```
37
+
38
+ For benchmark evaluation only (additional dependencies):
39
+ ```bash
40
+ pip install openai==4.1.1
41
+ pip install datasets==2.0.0
42
+ ```
43
+
44
+ ### Model Weights
45
+ Ensure your directory structure for the models looks like this:
46
+ ```
47
+ CodePlot-CoT
48
+ β”œβ”€β”€ ckpts
49
+ β”‚ β”œβ”€β”€ CodePlot-CoT
50
+ β”‚ β”œβ”€β”€ MatPlotCode
51
+ β”œβ”€β”€ ...
52
+ ```
53
+
54
+ ### Inference
55
+ You can perform inference using the provided scripts:
56
+
57
+ ```python
58
+ # Convert image to python code with MatPlotCode
59
+ python image_to_code.py
60
+ # Solve math problems with CodePlot-CoT
61
+ python math_infer.py
62
+ ```
63
+
64
+ For more details on evaluation and benchmarks, please refer to the [project homepage](https://math-vr.github.io) and the [GitHub repository](https://github.com/HKU-MMLab/Math-VR-CodePlot-CoT).
65
+
66
+ ## Citation
67
+ If you find this work helpful, please consider citing our paper:
68
+ ```bibtex
69
+ @article{duan2025code,
70
+ title={CodePlot-CoT: Mathematical Visual Reasoning by Thinking with Code-Driven Images},
71
+ author={Duan, Chengqi and Fang, Rongyao and Wang, Yuqing and Wang, Kun and Huang, Linjiang and Zeng, Xingyu and Li, Hongsheng and Liu, Xihui},
72
+ journal={arXiv preprint arXiv:2510.11718},
73
+ year={2025}
74
+ }
75
+ ```