Instructions to use gogoduan/CodePlot-CoT with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use gogoduan/CodePlot-CoT with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("image-text-to-text", model="gogoduan/CodePlot-CoT") messages = [ { "role": "user", "content": [ {"type": "image", "url": "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/p-blog/candy.JPG"}, {"type": "text", "text": "What animal is on the candy?"} ] }, ] pipe(text=messages)# Load model directly from transformers import AutoProcessor, AutoModelForImageTextToText processor = AutoProcessor.from_pretrained("gogoduan/CodePlot-CoT") model = AutoModelForImageTextToText.from_pretrained("gogoduan/CodePlot-CoT") messages = [ { "role": "user", "content": [ {"type": "image", "url": "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/p-blog/candy.JPG"}, {"type": "text", "text": "What animal is on the candy?"} ] }, ] inputs = processor.apply_chat_template( messages, add_generation_prompt=True, tokenize=True, return_dict=True, return_tensors="pt", ).to(model.device) outputs = model.generate(**inputs, max_new_tokens=40) print(processor.decode(outputs[0][inputs["input_ids"].shape[-1]:])) - Notebooks
- Google Colab
- Kaggle
- Local Apps
- vLLM
How to use gogoduan/CodePlot-CoT with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "gogoduan/CodePlot-CoT" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "gogoduan/CodePlot-CoT", "messages": [ { "role": "user", "content": [ { "type": "text", "text": "Describe this image in one sentence." }, { "type": "image_url", "image_url": { "url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg" } } ] } ] }'Use Docker
docker model run hf.co/gogoduan/CodePlot-CoT
- SGLang
How to use gogoduan/CodePlot-CoT with SGLang:
Install from pip and serve model
# Install SGLang from pip: pip install sglang # Start the SGLang server: python3 -m sglang.launch_server \ --model-path "gogoduan/CodePlot-CoT" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "gogoduan/CodePlot-CoT", "messages": [ { "role": "user", "content": [ { "type": "text", "text": "Describe this image in one sentence." }, { "type": "image_url", "image_url": { "url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg" } } ] } ] }'Use Docker images
docker run --gpus all \ --shm-size 32g \ -p 30000:30000 \ -v ~/.cache/huggingface:/root/.cache/huggingface \ --env "HF_TOKEN=<secret>" \ --ipc=host \ lmsysorg/sglang:latest \ python3 -m sglang.launch_server \ --model-path "gogoduan/CodePlot-CoT" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "gogoduan/CodePlot-CoT", "messages": [ { "role": "user", "content": [ { "type": "text", "text": "Describe this image in one sentence." }, { "type": "image_url", "image_url": { "url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg" } } ] } ] }' - Docker Model Runner
How to use gogoduan/CodePlot-CoT with Docker Model Runner:
docker model run hf.co/gogoduan/CodePlot-CoT
Enhance model card with metadata, links, and usage example (#1)
Browse files- Enhance model card with metadata, links, and usage example (29daaff5a3cac8f72e3a6471ae3bdf6a84c0aadb)
Co-authored-by: Niels Rogge <nielsr@users.noreply.huggingface.co>
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 git@github.com: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 |
+
```
|