Improve model card and add metadata

#1
by nielsr HF Staff - opened
Files changed (1) hide show
  1. README.md +56 -4
README.md CHANGED
@@ -1,8 +1,60 @@
1
- # Scal3R
 
 
2
 
3
- ## Download
 
 
 
 
 
 
 
 
4
 
5
  ```bash
6
- pip install -U huggingface_hub
7
- hf download xbillowy/Scal3R scal3r.pt --repo-type model --local-dir .
8
  ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ pipeline_tag: image-to-3d
3
+ ---
4
 
5
+ # Scal3R: Scalable Test-Time Training for Large-Scale 3D Reconstruction
6
+
7
+ [**Scal3R**](https://zju3dv.github.io/scal3r) is a framework for large-scale 3D scene reconstruction from long video sequences. It introduces a novel neural global context representation that efficiently compresses and retains long-range scene information, enabling the model to leverage extensive contextual cues for enhanced reconstruction accuracy and consistency.
8
+
9
+ [[Paper](https://arxiv.org/abs/2604.08542)] [[Project Page](https://zju3dv.github.io/scal3r)] [[GitHub](https://github.com/zju3dv/Scal3R)]
10
+
11
+ ## Installation
12
+
13
+ Use the automated installation script provided in the repository:
14
 
15
  ```bash
16
+ bash scripts/install.sh
 
17
  ```
18
+
19
+ ## Download Checkpoints
20
+
21
+ Download the required checkpoints to `data/checkpoints/`:
22
+
23
+ ```bash
24
+ mkdir -p data/checkpoints
25
+ hf download xbillowy/Scal3R scal3r.pt --repo-type model --local-dir data/checkpoints
26
+ curl -L https://github.com/serizba/salad/releases/download/v1.0.0/dino_salad.ckpt -o data/checkpoints/dino_salad.ckpt
27
+ ```
28
+
29
+ ## Usage
30
+
31
+ Run inference on a folder of images:
32
+
33
+ ```bash
34
+ python -m scal3r.run --input_dir /path/to/images
35
+ ```
36
+
37
+ You can also set an explicit tag or output directory:
38
+
39
+ ```bash
40
+ python -m scal3r.run \
41
+ --input_dir /path/to/images \
42
+ --tag demo \
43
+ --output_dir data/result/custom/demo
44
+ ```
45
+
46
+ For more details on arguments like `--block_size` and `--overlap_size`, please refer to the [GitHub repository](https://github.com/zju3dv/Scal3R).
47
+
48
+ ## Citation
49
+
50
+ ```bibtex
51
+ @misc{xie2026scal3rscalabletesttimetraining,
52
+ title={Scal3R: Scalable Test-Time Training for Large-Scale 3D Reconstruction},
53
+ author={Tao Xie and Peishan Yang and Yudong Jin and Yingfeng Cai and Wei Yin and Weiqiang Ren and Qian Zhang and Wei Hua and Sida Peng and Xiaoyang Guo and Xiaowei Zhou},
54
+ year={2026},
55
+ eprint={2604.08542},
56
+ archivePrefix={arXiv},
57
+ primaryClass={cs.CV},
58
+ url={https://arxiv.org/abs/2604.08542},
59
+ }
60
+ ```