Add pipeline tag and sample usage
Browse filesHi! I'm Niels from the Hugging Face community team. This PR improves your model card by adding the `image-to-3d` pipeline tag to the metadata, which helps with model discoverability on the Hub. I've also added a "Sample Usage" section with a code snippet showing how to download the checkpoints using the `huggingface_hub` library, based on the instructions in your GitHub README.
README.md
CHANGED
|
@@ -1,5 +1,4 @@
|
|
| 1 |
---
|
| 2 |
-
license: apache-2.0
|
| 3 |
datasets:
|
| 4 |
- multicam
|
| 5 |
- stereo4d
|
|
@@ -10,14 +9,17 @@ datasets:
|
|
| 10 |
- point_odyssey
|
| 11 |
- re10k
|
| 12 |
- dl3dv
|
|
|
|
| 13 |
metrics:
|
| 14 |
- psnr
|
| 15 |
- ssim
|
| 16 |
- lpips
|
|
|
|
| 17 |
---
|
|
|
|
| 18 |
# Model Card for Fast Spatial Memory Models
|
| 19 |
|
| 20 |
-
This repo is a public release of [**Fast Spatial Memory with Elastic Test-Time Training**](https://
|
| 21 |
|
| 22 |
## Model Details
|
| 23 |
|
|
@@ -25,12 +27,39 @@ This repo is a public release of [**Fast Spatial Memory with Elastic Test-Time T
|
|
| 25 |
|
| 26 |
- **Developed by:** [MIT-IBM Watson Lab]
|
| 27 |
- **License:** [Apache License 2.0]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 28 |
|
| 29 |
-
##
|
| 30 |
|
| 31 |
-
|
| 32 |
-
|
| 33 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 34 |
|
| 35 |
## Performance Documentations
|
| 36 |
|
|
|
|
| 1 |
---
|
|
|
|
| 2 |
datasets:
|
| 3 |
- multicam
|
| 4 |
- stereo4d
|
|
|
|
| 9 |
- point_odyssey
|
| 10 |
- re10k
|
| 11 |
- dl3dv
|
| 12 |
+
license: apache-2.0
|
| 13 |
metrics:
|
| 14 |
- psnr
|
| 15 |
- ssim
|
| 16 |
- lpips
|
| 17 |
+
pipeline_tag: image-to-3d
|
| 18 |
---
|
| 19 |
+
|
| 20 |
# Model Card for Fast Spatial Memory Models
|
| 21 |
|
| 22 |
+
This repo is a public release of [**Fast Spatial Memory with Elastic Test-Time Training**](https://fast-spatial-memory.github.io/), as well as a *self-retrained (non-official!)* version of [**4D-LRM**](https://4dlrm.github.io/).
|
| 23 |
|
| 24 |
## Model Details
|
| 25 |
|
|
|
|
| 27 |
|
| 28 |
- **Developed by:** [MIT-IBM Watson Lab]
|
| 29 |
- **License:** [Apache License 2.0]
|
| 30 |
+
- **Task:** 3D/4D Reconstruction from long observation sequences.
|
| 31 |
+
|
| 32 |
+
### Model Sources
|
| 33 |
+
|
| 34 |
+
- **Repository:** [https://github.com/Mars-tin/fast-spatial-mem](https://github.com/Mars-tin/fast-spatial-mem)
|
| 35 |
+
- **Paper:** [https://arxiv.org/abs/2604.07350](https://arxiv.org/abs/2604.07350)
|
| 36 |
+
- **Homepage:** [https://fast-spatial-memory.github.io/](https://fast-spatial-memory.github.io/)
|
| 37 |
|
| 38 |
+
## Sample Usage
|
| 39 |
|
| 40 |
+
You can download the pretrained weights from this repository using the `hf_hub_download` function from the `huggingface_hub` library:
|
| 41 |
+
|
| 42 |
+
```python
|
| 43 |
+
import os
|
| 44 |
+
import shutil
|
| 45 |
+
from huggingface_hub import hf_hub_download
|
| 46 |
+
|
| 47 |
+
repo_id = "marstin/fast-spatial-mem"
|
| 48 |
+
local_path = "static/weights"
|
| 49 |
+
path_in_repo = "lvsm_checkpoints/fsm_4dlvsm_patch8_res256.pth"
|
| 50 |
+
|
| 51 |
+
# Download (cached under ~/.cache/huggingface/hub)
|
| 52 |
+
cached_path = hf_hub_download(
|
| 53 |
+
repo_id=repo_id,
|
| 54 |
+
filename=path_in_repo,
|
| 55 |
+
repo_type="model"
|
| 56 |
+
)
|
| 57 |
+
|
| 58 |
+
# Copy to your desired local folder
|
| 59 |
+
os.makedirs(os.path.dirname(local_path), exist_ok=True)
|
| 60 |
+
target_path = os.path.join(local_path, os.path.basename(path_in_repo))
|
| 61 |
+
shutil.copy(cached_path, target_path)
|
| 62 |
+
```
|
| 63 |
|
| 64 |
## Performance Documentations
|
| 65 |
|