Flor commited on
Commit
32cdcd9
·
0 Parent(s):

fastforks 0.1.0

Browse files
Files changed (2) hide show
  1. .gitattributes +35 -0
  2. README.md +94 -0
.gitattributes ADDED
@@ -0,0 +1,35 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ *.7z filter=lfs diff=lfs merge=lfs -text
2
+ *.arrow filter=lfs diff=lfs merge=lfs -text
3
+ *.bin filter=lfs diff=lfs merge=lfs -text
4
+ *.bz2 filter=lfs diff=lfs merge=lfs -text
5
+ *.ckpt filter=lfs diff=lfs merge=lfs -text
6
+ *.ftz filter=lfs diff=lfs merge=lfs -text
7
+ *.gz filter=lfs diff=lfs merge=lfs -text
8
+ *.h5 filter=lfs diff=lfs merge=lfs -text
9
+ *.joblib filter=lfs diff=lfs merge=lfs -text
10
+ *.lfs.* filter=lfs diff=lfs merge=lfs -text
11
+ *.mlmodel filter=lfs diff=lfs merge=lfs -text
12
+ *.model filter=lfs diff=lfs merge=lfs -text
13
+ *.msgpack filter=lfs diff=lfs merge=lfs -text
14
+ *.npy filter=lfs diff=lfs merge=lfs -text
15
+ *.npz filter=lfs diff=lfs merge=lfs -text
16
+ *.onnx filter=lfs diff=lfs merge=lfs -text
17
+ *.ot filter=lfs diff=lfs merge=lfs -text
18
+ *.parquet filter=lfs diff=lfs merge=lfs -text
19
+ *.pb filter=lfs diff=lfs merge=lfs -text
20
+ *.pickle filter=lfs diff=lfs merge=lfs -text
21
+ *.pkl filter=lfs diff=lfs merge=lfs -text
22
+ *.pt filter=lfs diff=lfs merge=lfs -text
23
+ *.pth filter=lfs diff=lfs merge=lfs -text
24
+ *.rar filter=lfs diff=lfs merge=lfs -text
25
+ *.safetensors filter=lfs diff=lfs merge=lfs -text
26
+ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
27
+ *.tar.* filter=lfs diff=lfs merge=lfs -text
28
+ *.tar filter=lfs diff=lfs merge=lfs -text
29
+ *.tflite filter=lfs diff=lfs merge=lfs -text
30
+ *.tgz filter=lfs diff=lfs merge=lfs -text
31
+ *.wasm filter=lfs diff=lfs merge=lfs -text
32
+ *.xz filter=lfs diff=lfs merge=lfs -text
33
+ *.zip filter=lfs diff=lfs merge=lfs -text
34
+ *.zst filter=lfs diff=lfs merge=lfs -text
35
+ *tfevents* filter=lfs diff=lfs merge=lfs -text
README.md ADDED
@@ -0,0 +1,94 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ library_name: "fastforks"
3
+ pipeline_tag: "depth-estimation"
4
+ license: "other"
5
+ license_name: "noncommercial-and-cc-by-nc-4.0"
6
+ license_link: "https://github.com/Junda24/MonSter-plusplus/blob/9167101af8fbe93c706707daa7a8181089c8b1b4/LICENSE#L34"
7
+ tags:
8
+ - "stereo"
9
+ - "stereo-matching"
10
+ - "disparity"
11
+ - "cuda"
12
+ - "pytorch"
13
+ - "fastforks"
14
+ ---
15
+ # MonSter++ (fastforks)
16
+
17
+ MonSter++ (Cheng et al. 2025), accuracy model (the MonSter network, max disparity 416): Depth Anything V2 (ViT-L) monocular branch + IGEV-style geometry volume, with stereo and mono ConvGRUs that refine each other, 32 iterations.
18
+
19
+ This repo is the model card only: it holds no weights. fastforks downloads the authors' weights from the links below and checks them against the SHA-256 in the model card. Code: <https://github.com/kleinicke/fastforks>. Kernels for the `kernels` backend: <https://huggingface.co/fastforks/kernels>. Original code: <https://github.com/Junda24/MonSter-plusplus> at `9167101af8fb`.
20
+
21
+ Author weight repos: <https://huggingface.co/cjd24/MonSter-plusplus>.
22
+
23
+ Task: stereo. Tier: experimental. Outputs: `disparity`. Backends: `portable`, `kernels`.
24
+
25
+ Input: a rectified left / right image pair. Output: a disparity map (pixels, left view).
26
+
27
+ ## Variants
28
+
29
+ Weights are the authors' files (not hosted here). SHA-256 shortened to 12 hex digits; the full hashes are in [`card.toml`](https://github.com/kleinicke/fastforks/blob/main/src/fastforks/stereo/models/monster_plusplus/card.toml).
30
+
31
+ | variant | weights (author link) | SHA-256 | weights licence | commercial use |
32
+ |---|---|---|---|---|
33
+ | `monster-plusplus-mix-all@1` | [Mix_all_large.pth](https://huggingface.co/cjd24/MonSter-plusplus/resolve/main/Mix_all_large.pth?download=true) | `e86dede921dc` | LicenseRef-noncommercial AND CC-BY-NC-4.0 | **no** |
34
+
35
+ ## Licence
36
+
37
+ Original-code strings, recorded as they are (research-use package; check them before any other use). Code: LicenseRef-noncommercial. Files: `LICENSE`.
38
+
39
+ Training data: mix_all: 'all the datasets we collect over 2M image pairs' (README), not listed.
40
+
41
+ Licence evidence: <https://github.com/Junda24/MonSter-plusplus/blob/9167101af8fbe93c706707daa7a8181089c8b1b4/LICENSE#L34>
42
+
43
+ ## Input size
44
+
45
+ any H x W >= 32, padded to a multiple of 32
46
+ Tested up to (portable, fp16, RTX 5060 Ti 16 GB): `monster-plusplus-mix-all` 1988x2880 (7.7 GiB peak allocated, 9.6 reserved)
47
+
48
+ ## Speed and memory
49
+
50
+ ### Stereo, Middlebury 2014 half, 994x1482
51
+
52
+ | model | time (ms): original fp32 | original | portable | kernels | kernels speed-up: vs original | vs portable | peak memory (MiB, allocated / reserved): original | portable | kernels |
53
+ | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
54
+ | `monster-plusplus-mix-all` | 4339.1 | 4334.5 | 1632.62 | 697.92 | 6.2x | 2.3x | 6382 / 6430 | 2583 / 2918 | 2438 / 2760 |
55
+
56
+ ### Startup and first call
57
+
58
+ | model | load (s): original | portable | kernels | first call (s): original | portable | kernels |
59
+ | --- | --- | --- | --- | --- | --- | --- |
60
+ | `monster-plusplus-mix-all` | 8.37 (375x1242) | 2.45 | 0.79† | 1.23 (375x1242) | 1.63† | 0.70† |
61
+
62
+ ### Fixed-size speed and peak memory, all models
63
+
64
+ | model | mode | 640x480 | 1280x720 | 1920x1080 | 12 MP 4000x3000 |
65
+ | --- | --- | --- | --- | --- | --- |
66
+ | `monster-plusplus-mix-all` | portable | 294.3 ms / 1138 / 1246 | 928.8 ms / 1880 / 2318 | 2370.0 ms (n=3) / 3269 / 3812 | OOM |
67
+ | `monster-plusplus-mix-all` | kernels | 132.9 ms / 1130 / 1270 | 396.3 ms / 1804 / 2344 | 998.1 ms / 3051 / 3724 | OOM |
68
+
69
+ Fixed-size cells: time (ms) / peak allocated / peak reserved memory (MiB).
70
+
71
+ Hardware, protocol and caveats: [benchmarks](https://github.com/kleinicke/fastforks/blob/main/docs/benchmarks.md) (RTX 5060 Ti 16 GB, sm_120). Original = the authors' code at the precision of portable (fp16, or `(fp32)` where fp16 is unsupported or not finite); original fp32 = its default fp32 run. Peak memory is the torch allocator's.
72
+
73
+ ## Accuracy
74
+
75
+ ### Parity with the original code
76
+
77
+ Every variant is checked against golden outputs of the original code at its pinned commit. CPU, float32: max |diff| <= 0.2 vs the original. GPU, float16 (the default), portable and kernels: mean |diff| <= 0.03 px and p99 <= 0.25 px.
78
+
79
+ ## Usage
80
+
81
+ ```python
82
+ from fastforks import stereo
83
+
84
+ model = stereo.load("monster-plusplus-mix-all") # portable PyTorch on the GPU if there is one, else the CPU
85
+ result = model("left.png", "right.png")
86
+ result.disparity # [H, W] float32 tensor, input resolution
87
+ result.backend # what ran, e.g. Backend(mode='portable', device='cuda:0', dtype='float16')
88
+ ```
89
+
90
+ Install with `pip install fastforks` (see <https://github.com/kleinicke/fastforks>). Other variants: `monster-plusplus-mix-all`.
91
+
92
+ ## Kernels backend
93
+
94
+ `stereo.load("monster-plusplus-mix-all", mode="kernels")` runs our CUDA kernels (`igev`, `igevpp`, `cutlass_conv`, `cudnn_hacc`, `fastbb`). It needs a prebuilt kernel for your GPU architecture (downloaded from <https://huggingface.co/fastforks/kernels> on first use) and a recent NVIDIA driver; if there is none it raises `BackendUnavailableError` with the reason and never falls back silently. `mode="auto"` picks `kernels` when it can run and logs the choice.