Promote manual_0429 as flagship checkpoint
Browse filesUpdate the model card, compatibility metadata, and checksum manifest. Remove five deprecated checkpoints from main.
README.md
CHANGED
|
@@ -20,7 +20,7 @@ tags:
|
|
| 20 |
|
| 21 |
VesselBoost segments small blood vessels in high-resolution human brain MRI. The primary models target time-of-flight magnetic resonance angiography (TOF-MRA). One checkpoint, `t2s_mod_ep1k2_0728`, provides experimental support for T2*-weighted MRI.
|
| 22 |
|
| 23 |
-
These files are PyTorch state dictionaries for use with the VesselBoost
|
| 24 |
|
| 25 |
**Research use only. Not validated for clinical diagnosis, treatment planning, or other clinical decision-making.**
|
| 26 |
|
|
@@ -30,9 +30,9 @@ The checkpoints use the VesselBoost 3D U-Net with one input channel, one output
|
|
| 30 |
|
| 31 |
The corresponding source release is pinned to:
|
| 32 |
|
| 33 |
-
- VesselBoost version: `2.0.
|
| 34 |
-
- Git tag: [`v2.0.
|
| 35 |
-
- Git commit: [`
|
| 36 |
|
| 37 |
See `config.json` for the machine-readable inference configuration.
|
| 38 |
|
|
@@ -40,19 +40,14 @@ See `config.json` for the machine-readable inference configuration.
|
|
| 40 |
|
| 41 |
All pretrained checkpoints are stored under `weights/`. Their original filenames and serialization formats are preserved from the original release.
|
| 42 |
|
| 43 |
-
| Checkpoint
|
| 44 |
-
| -------------------------------------
|
| 45 |
-
| [`
|
| 46 |
-
| [`
|
| 47 |
-
| [`
|
| 48 |
-
| [`
|
| 49 |
-
| [`VB2_aug_spatial_ep2k_bat10_0903`](weights/VB2_aug_spatial_ep2k_bat10_0903) | TOF-MRA | Augmentation ablation using the spatial augmentation configuration. |
|
| 50 |
-
| [`manual_0429`](weights/manual_0429) | TOF-MRA | Legacy checkpoint associated with the manual-label training run and used in VesselBoost v2.0.2 examples. |
|
| 51 |
-
| [`omelette1_0429`](weights/omelette1_0429) | TOF-MRA | Legacy TOF-MRA checkpoint identified as Omelette variant 1. |
|
| 52 |
-
| [`omelette2_0429`](weights/omelette2_0429) | TOF-MRA | Legacy TOF-MRA checkpoint identified as Omelette variant 2. |
|
| 53 |
-
| [`t2s_mod_ep1k2_0728`](weights/t2s_mod_ep1k2_0728) | T2*-weighted MRI | Experimental T2*-weighted vessel-segmentation checkpoint. It has not received the same validation as the primary TOF-MRA model. |
|
| 54 |
|
| 55 |
-
|
| 56 |
|
| 57 |
## Downloading checkpoints
|
| 58 |
|
|
@@ -66,11 +61,11 @@ Download the primary TOF-MRA checkpoint:
|
|
| 66 |
|
| 67 |
```bash
|
| 68 |
hf download BrainVascuLab/VesselBoost \
|
| 69 |
-
weights/
|
| 70 |
--local-dir saved_models
|
| 71 |
```
|
| 72 |
|
| 73 |
-
The downloaded checkpoint will be available at `saved_models/weights/
|
| 74 |
|
| 75 |
Download every pretrained checkpoint and the checksum manifest:
|
| 76 |
|
|
@@ -84,7 +79,7 @@ For reproducible automated workflows, pass `--revision` with a specific Hugging
|
|
| 84 |
|
| 85 |
## Preprocessing and inference
|
| 86 |
|
| 87 |
-
VesselBoost v2.0.
|
| 88 |
|
| 89 |
1. Load a single-channel NIfTI MRI volume.
|
| 90 |
2. Resize each spatial dimension to at least 64 voxels and to a multiple of 64, using nearest-neighbor interpolation.
|
|
@@ -106,7 +101,7 @@ cd saved_models/weights
|
|
| 106 |
sha256sum --check MANIFEST.sha256
|
| 107 |
```
|
| 108 |
|
| 109 |
-
All
|
| 110 |
|
| 111 |
Load the checkpoints with the pinned VesselBoost source and map tensors to the intended device. When supported by the installed PyTorch version, use `weights_only=True` when loading these state dictionaries.
|
| 112 |
|
|
|
|
| 20 |
|
| 21 |
VesselBoost segments small blood vessels in high-resolution human brain MRI. The primary models target time-of-flight magnetic resonance angiography (TOF-MRA). One checkpoint, `t2s_mod_ep1k2_0728`, provides experimental support for T2*-weighted MRI.
|
| 22 |
|
| 23 |
+
These files are PyTorch state dictionaries for use with the VesselBoost prediction and test-time adaptation workflows. They are not standalone Hugging Face Transformers models or hosted inference endpoints.
|
| 24 |
|
| 25 |
**Research use only. Not validated for clinical diagnosis, treatment planning, or other clinical decision-making.**
|
| 26 |
|
|
|
|
| 30 |
|
| 31 |
The corresponding source release is pinned to:
|
| 32 |
|
| 33 |
+
- VesselBoost version: `2.0.5`
|
| 34 |
+
- Git tag: [`v2.0.5`](https://github.com/KMarshallX/VesselBoost/tree/v2.0.5)
|
| 35 |
+
- Git commit: [`3f028bbd6784c8fac82ac872a70aa06de2e162ae`](https://github.com/KMarshallX/VesselBoost/commit/3f028bbd6784c8fac82ac872a70aa06de2e162ae)
|
| 36 |
|
| 37 |
See `config.json` for the machine-readable inference configuration.
|
| 38 |
|
|
|
|
| 40 |
|
| 41 |
All pretrained checkpoints are stored under `weights/`. Their original filenames and serialization formats are preserved from the original release.
|
| 42 |
|
| 43 |
+
| Checkpoint | MRI contrast | Description |
|
| 44 |
+
| -------------------------------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------- |
|
| 45 |
+
| [`manual_0429`](weights/manual_0429) | TOF-MRA | Flagship TOF-MRA checkpoint referenced by the current VesselBoost documentation and automated tests. |
|
| 46 |
+
| [`omelette1_0429`](weights/omelette1_0429) | TOF-MRA | Legacy TOF-MRA checkpoint identified as Omelette variant 1. |
|
| 47 |
+
| [`omelette2_0429`](weights/omelette2_0429) | TOF-MRA | Legacy TOF-MRA checkpoint identified as Omelette variant 2. |
|
| 48 |
+
| [`t2s_mod_ep1k2_0728`](weights/t2s_mod_ep1k2_0728) | T2*-weighted MRI | Experimental T2*-weighted vessel-segmentation checkpoint. It has not received the same validation as the flagship TOF-MRA model. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 49 |
|
| 50 |
+
For standard TOF-MRA prediction and test-time adaptation workflows, use the flagship `manual_0429` checkpoint.
|
| 51 |
|
| 52 |
## Downloading checkpoints
|
| 53 |
|
|
|
|
| 61 |
|
| 62 |
```bash
|
| 63 |
hf download BrainVascuLab/VesselBoost \
|
| 64 |
+
weights/manual_0429 \
|
| 65 |
--local-dir saved_models
|
| 66 |
```
|
| 67 |
|
| 68 |
+
The downloaded checkpoint will be available at `saved_models/weights/manual_0429`.
|
| 69 |
|
| 70 |
Download every pretrained checkpoint and the checksum manifest:
|
| 71 |
|
|
|
|
| 79 |
|
| 80 |
## Preprocessing and inference
|
| 81 |
|
| 82 |
+
VesselBoost v2.0.5 performs the following inference operations:
|
| 83 |
|
| 84 |
1. Load a single-channel NIfTI MRI volume.
|
| 85 |
2. Resize each spatial dimension to at least 64 voxels and to a multiple of 64, using nearest-neighbor interpolation.
|
|
|
|
| 101 |
sha256sum --check MANIFEST.sha256
|
| 102 |
```
|
| 103 |
|
| 104 |
+
All four checkpoints should report `OK`.
|
| 105 |
|
| 106 |
Load the checkpoints with the pinned VesselBoost source and map tensors to the intended device. When supported by the installed PyTorch version, use `weights_only=True` when loading these state dictionaries.
|
| 107 |
|
config.json
CHANGED
|
@@ -48,9 +48,9 @@
|
|
| 48 |
},
|
| 49 |
"checkpoint_format": "PyTorch state_dict ZIP serialization",
|
| 50 |
"compatible_vesselboost": {
|
| 51 |
-
"version": "2.0.
|
| 52 |
-
"git_tag": "v2.0.
|
| 53 |
-
"git_commit": "
|
| 54 |
-
"source_url": "https://github.com/KMarshallX/VesselBoost/tree/v2.0.
|
| 55 |
}
|
| 56 |
}
|
|
|
|
| 48 |
},
|
| 49 |
"checkpoint_format": "PyTorch state_dict ZIP serialization",
|
| 50 |
"compatible_vesselboost": {
|
| 51 |
+
"version": "2.0.5",
|
| 52 |
+
"git_tag": "v2.0.5",
|
| 53 |
+
"git_commit": "3f028bbd6784c8fac82ac872a70aa06de2e162ae",
|
| 54 |
+
"source_url": "https://github.com/KMarshallX/VesselBoost/tree/v2.0.5"
|
| 55 |
}
|
| 56 |
}
|
weights/BM_VB2_aug_all_ep2k_bat_10_0903
DELETED
|
@@ -1,3 +0,0 @@
|
|
| 1 |
-
version https://git-lfs.github.com/spec/v1
|
| 2 |
-
oid sha256:ff51c8e6c79947f13bf7c24ac2ae2242eb4b23b7739e62dc3f8344944bde28f1
|
| 3 |
-
size 26397502
|
|
|
|
|
|
|
|
|
|
|
|
weights/MANIFEST.sha256
CHANGED
|
@@ -1,9 +1,3 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
09b28d972172939f554f3884de9570f9584720b5c8fd225d620e812e48507461 VB2_aug_random_ep2k_bat10_0903
|
| 5 |
-
a5bb099eaa70b1c61f948c5475002083b7637c118ed5525124dece20100de4d4 VB2_aug_spatial_ep2k_bat10_0903
|
| 6 |
-
fb318efe161b0036f2af2585fb282dd92ab45c6f0258422154340f05a2b3ef80 manual_0429
|
| 7 |
-
980cbbd4cdd85fc731cc5bc621b402ebcc1f0abba028ced4b6035bf92ebaa212 omelette1_0429
|
| 8 |
-
d18245068d8a196d52d9cbaa841a0eff314c5673e5bef85af60bf482d28d1633 omelette2_0429
|
| 9 |
-
794d8e333ae0b26578824debc375950a0637868deca3f16656dc81e0076951ad t2s_mod_ep1k2_0728
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:74b0316c2fe09e75f8f41c3d0972723215a5029537924cd10d404e17960e1dc7
|
| 3 |
+
size 325
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
weights/VB2_aug_intensity_ep2k_bat10_0903
DELETED
|
@@ -1,3 +0,0 @@
|
|
| 1 |
-
version https://git-lfs.github.com/spec/v1
|
| 2 |
-
oid sha256:73b3cabf38dcb4266507f375c67f7f6e1fa3e57747ff9ae5b9a2285175462ada
|
| 3 |
-
size 26398202
|
|
|
|
|
|
|
|
|
|
|
|
weights/VB2_aug_off_ep2k_bat10_0903
DELETED
|
@@ -1,3 +0,0 @@
|
|
| 1 |
-
version https://git-lfs.github.com/spec/v1
|
| 2 |
-
oid sha256:056849b426a669a7536d57b270803fa9a2dab69d9f8abbfcb865d028864db961
|
| 3 |
-
size 26397362
|
|
|
|
|
|
|
|
|
|
|
|
weights/VB2_aug_random_ep2k_bat10_0903
DELETED
|
@@ -1,3 +0,0 @@
|
|
| 1 |
-
version https://git-lfs.github.com/spec/v1
|
| 2 |
-
oid sha256:09b28d972172939f554f3884de9570f9584720b5c8fd225d620e812e48507461
|
| 3 |
-
size 26397782
|
|
|
|
|
|
|
|
|
|
|
|
weights/VB2_aug_spatial_ep2k_bat10_0903
DELETED
|
@@ -1,3 +0,0 @@
|
|
| 1 |
-
version https://git-lfs.github.com/spec/v1
|
| 2 |
-
oid sha256:a5bb099eaa70b1c61f948c5475002083b7637c118ed5525124dece20100de4d4
|
| 3 |
-
size 26397922
|
|
|
|
|
|
|
|
|
|
|
|