Update model card for weights layout and CI bucket
Browse filesDocument weights/ downloads and checksum verification, link the public VesselBoost CI bucket, describe mutable CI outputs, and track future extensionless checkpoints under weights/ with Xet/LFS.
- .gitattributes +1 -0
- README.md +60 -11
.gitattributes
CHANGED
|
@@ -42,3 +42,4 @@ manual_0429 filter=lfs diff=lfs merge=lfs -text
|
|
| 42 |
omelette1_0429 filter=lfs diff=lfs merge=lfs -text
|
| 43 |
omelette2_0429 filter=lfs diff=lfs merge=lfs -text
|
| 44 |
t2s_mod_ep1k2_0728 filter=lfs diff=lfs merge=lfs -text
|
|
|
|
|
|
| 42 |
omelette1_0429 filter=lfs diff=lfs merge=lfs -text
|
| 43 |
omelette2_0429 filter=lfs diff=lfs merge=lfs -text
|
| 44 |
t2s_mod_ep1k2_0728 filter=lfs diff=lfs merge=lfs -text
|
| 45 |
+
weights/** filter=lfs diff=lfs merge=lfs -text
|
README.md
CHANGED
|
@@ -2,6 +2,8 @@
|
|
| 2 |
license: mit
|
| 3 |
library_name: pytorch
|
| 4 |
pipeline_tag: image-segmentation
|
|
|
|
|
|
|
| 5 |
tags:
|
| 6 |
- medical-imaging
|
| 7 |
- mri
|
|
@@ -36,22 +38,50 @@ See `config.json` for the machine-readable inference configuration.
|
|
| 36 |
|
| 37 |
## Checkpoints
|
| 38 |
|
| 39 |
-
|
| 40 |
|
| 41 |
| Checkpoint | MRI contrast | Description |
|
| 42 |
| ------------------------------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
| 43 |
-
| `BM_VB2_aug_all_ep2k_bat_10_0903` | TOF-MRA | Primary TOF-MRA checkpoint referenced by the VesselBoost documentation and tests; trained with the combined augmentation configuration. |
|
| 44 |
-
| `VB2_aug_intensity_ep2k_bat10_0903` | TOF-MRA | Augmentation ablation using the intensity augmentation configuration. |
|
| 45 |
-
| `VB2_aug_off_ep2k_bat10_0903` | TOF-MRA | Augmentation ablation with augmentation disabled. |
|
| 46 |
-
| `VB2_aug_random_ep2k_bat10_0903` | TOF-MRA | Augmentation ablation using the random augmentation configuration. |
|
| 47 |
-
| `VB2_aug_spatial_ep2k_bat10_0903` | TOF-MRA | Augmentation ablation using the spatial augmentation configuration. |
|
| 48 |
-
| `manual_0429` | TOF-MRA | Legacy checkpoint associated with the manual-label training run and used in VesselBoost v2.0.2 examples. |
|
| 49 |
-
| `omelette1_0429` | TOF-MRA | Legacy TOF-MRA checkpoint identified as Omelette variant 1. |
|
| 50 |
-
| `omelette2_0429` | TOF-MRA | Legacy TOF-MRA checkpoint identified as Omelette variant 2.Β |
|
| 51 |
-
| `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. |
|
| 52 |
|
| 53 |
The augmentation-specific checkpoints are included to preserve the original model set and support comparison or reproduction of augmentation experiments. For the standard TOF-MRA prediction workflow, use `manual_0429` or `BM_VB2_aug_all_ep2k_bat_10_0903` unless reproducing a specific legacy experiment.
|
| 54 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 55 |
## Preprocessing and inference
|
| 56 |
|
| 57 |
VesselBoost v2.0.2 performs the following inference operations:
|
|
@@ -69,12 +99,15 @@ VesselBoost preprocessing modes can optionally perform N4 bias-field correction,
|
|
| 69 |
|
| 70 |
## Integrity verification
|
| 71 |
|
| 72 |
-
SHA-256 checksums are provided in `MANIFEST.sha256`.
|
| 73 |
|
| 74 |
```bash
|
|
|
|
| 75 |
sha256sum --check MANIFEST.sha256
|
| 76 |
```
|
| 77 |
|
|
|
|
|
|
|
| 78 |
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.
|
| 79 |
|
| 80 |
## Known limitations and expected failure cases
|
|
@@ -89,6 +122,22 @@ Load the checkpoints with the pinned VesselBoost source and map tensors to the i
|
|
| 89 |
- Training labels for small vessels can be incomplete or imperfect. Predictions should not be interpreted as a complete representation of the cerebral vasculature.
|
| 90 |
- Detailed provenance for `manual_0429`, `omelette1_0429`, and `omelette2_0429` training runs is documented in our ApertureNeuro journal article *VesselBoost: A Python Toolbox for Small Blood Vessel Segmentation in Human Magnetic Resonance Angiography Data*.
|
| 91 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 92 |
## Resources and citation
|
| 93 |
|
| 94 |
- Paper DOI: [10.52294/001c.123217](https://doi.org/10.52294/001c.123217)
|
|
|
|
| 2 |
license: mit
|
| 3 |
library_name: pytorch
|
| 4 |
pipeline_tag: image-segmentation
|
| 5 |
+
buckets:
|
| 6 |
+
- BrainVascuLab/vesselboost-ci
|
| 7 |
tags:
|
| 8 |
- medical-imaging
|
| 9 |
- mri
|
|
|
|
| 38 |
|
| 39 |
## Checkpoints
|
| 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 |
+
| [`BM_VB2_aug_all_ep2k_bat_10_0903`](weights/BM_VB2_aug_all_ep2k_bat_10_0903) | TOF-MRA | Primary TOF-MRA checkpoint referenced by the VesselBoost documentation and tests; trained with the combined augmentation configuration. |
|
| 46 |
+
| [`VB2_aug_intensity_ep2k_bat10_0903`](weights/VB2_aug_intensity_ep2k_bat10_0903) | TOF-MRA | Augmentation ablation using the intensity augmentation configuration. |
|
| 47 |
+
| [`VB2_aug_off_ep2k_bat10_0903`](weights/VB2_aug_off_ep2k_bat10_0903) | TOF-MRA | Augmentation ablation with augmentation disabled. |
|
| 48 |
+
| [`VB2_aug_random_ep2k_bat10_0903`](weights/VB2_aug_random_ep2k_bat10_0903) | TOF-MRA | Augmentation ablation using the random augmentation configuration. |
|
| 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 |
The augmentation-specific checkpoints are included to preserve the original model set and support comparison or reproduction of augmentation experiments. For the standard TOF-MRA prediction workflow, use `manual_0429` or `BM_VB2_aug_all_ep2k_bat_10_0903` unless reproducing a specific legacy experiment.
|
| 56 |
|
| 57 |
+
## Downloading checkpoints
|
| 58 |
+
|
| 59 |
+
Install the Hugging Face command-line client:
|
| 60 |
+
|
| 61 |
+
```bash
|
| 62 |
+
python -m pip install huggingface_hub
|
| 63 |
+
```
|
| 64 |
+
|
| 65 |
+
Download the primary TOF-MRA checkpoint:
|
| 66 |
+
|
| 67 |
+
```bash
|
| 68 |
+
hf download BrainVascuLab/VesselBoost \
|
| 69 |
+
weights/BM_VB2_aug_all_ep2k_bat_10_0903 \
|
| 70 |
+
--local-dir saved_models
|
| 71 |
+
```
|
| 72 |
+
|
| 73 |
+
The downloaded checkpoint will be available at `saved_models/weights/BM_VB2_aug_all_ep2k_bat_10_0903`.
|
| 74 |
+
|
| 75 |
+
Download every pretrained checkpoint and the checksum manifest:
|
| 76 |
+
|
| 77 |
+
```bash
|
| 78 |
+
hf download BrainVascuLab/VesselBoost \
|
| 79 |
+
--include "weights/*" \
|
| 80 |
+
--local-dir saved_models
|
| 81 |
+
```
|
| 82 |
+
|
| 83 |
+
For reproducible automated workflows, pass `--revision` with a specific Hugging Face commit hash rather than relying on the moving `main` branch.
|
| 84 |
+
|
| 85 |
## Preprocessing and inference
|
| 86 |
|
| 87 |
VesselBoost v2.0.2 performs the following inference operations:
|
|
|
|
| 99 |
|
| 100 |
## Integrity verification
|
| 101 |
|
| 102 |
+
SHA-256 checksums for every checkpoint are provided in [`weights/MANIFEST.sha256`](weights/MANIFEST.sha256). After downloading all files, verify them with:
|
| 103 |
|
| 104 |
```bash
|
| 105 |
+
cd saved_models/weights
|
| 106 |
sha256sum --check MANIFEST.sha256
|
| 107 |
```
|
| 108 |
|
| 109 |
+
All nine checkpoints should report `OK`.
|
| 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 |
|
| 113 |
## Known limitations and expected failure cases
|
|
|
|
| 122 |
- Training labels for small vessels can be incomplete or imperfect. Predictions should not be interpreted as a complete representation of the cerebral vasculature.
|
| 123 |
- Detailed provenance for `manual_0429`, `omelette1_0429`, and `omelette2_0429` training runs is documented in our ApertureNeuro journal article *VesselBoost: A Python Toolbox for Small Blood Vessel Segmentation in Human Magnetic Resonance Angiography Data*.
|
| 124 |
|
| 125 |
+
## GitHub Actions CI outputs
|
| 126 |
+
|
| 127 |
+
The latest generated outputs from VesselBoost's GitHub Actions test workflows are stored in the public [VesselBoost CI bucket](https://huggingface.co/buckets/BrainVascuLab/vesselboost-ci).
|
| 128 |
+
|
| 129 |
+
The bucket uses the following layout:
|
| 130 |
+
|
| 131 |
+
```text
|
| 132 |
+
github_actions/
|
| 133 |
+
βββ boost/predicted_labels/
|
| 134 |
+
βββ prediction/predicted_labels/
|
| 135 |
+
βββ train/saved_model/
|
| 136 |
+
βββ tta/predicted_labels/
|
| 137 |
+
```
|
| 138 |
+
|
| 139 |
+
These files are automated CI diagnostics, not validated model releases or benchmark results. Each successful push-triggered workflow replaces the previous contents of its corresponding directory.
|
| 140 |
+
|
| 141 |
## Resources and citation
|
| 142 |
|
| 143 |
- Paper DOI: [10.52294/001c.123217](https://doi.org/10.52294/001c.123217)
|