Update model card with Primus paper and segmentation tag

#1
by nielsr HF Staff - opened
Files changed (1) hide show
  1. README.md +38 -29
README.md CHANGED
@@ -1,18 +1,22 @@
1
  ---
2
- license: cc-by-4.0
3
  datasets:
4
  - AnonRes/OpenMind
5
- pipeline_tag: image-feature-extraction
 
 
6
  tags:
7
  - medical
8
  ---
9
 
10
- # OpenMind Benchmark 3D SSL Models
 
 
11
 
12
- > **Model from the paper**: [An OpenMind for 3D medical vision self-supervised learning](https://arxiv.org/abs/2412.17041)
13
- > **Pre-training codebase used to create checkpoint**: [MIC-DKFZ/nnssl](https://github.com/MIC-DKFZ/nnssl)
14
- > **Dataset**: [AnonRes/OpenMind](https://huggingface.co/datasets/AnonRes/OpenMind)
15
- > **Downstream (segmentation) fine-tuning**: [TaWald/nnUNet](https://github.com/TaWald/nnUNet)
 
16
 
17
  ---
18
 
@@ -20,33 +24,38 @@ tags:
20
 
21
  ## Overview
22
 
23
- This repository hosts pre-trained checkpoints from the **OpenMind** benchmark:
24
- 📄 **An OpenMind for 3D medical vision self-supervised learning** (Wald, T., Ulrich, C., Suprijadi, J., Ziegler, S., Nohel, M., Peretzke, R., ... & Maier-Hein, K. H. (2024).)
25
- ([arXiv:2412.17041](https://arxiv.org/abs/2412.17041)) — the first extensive benchmark study for **self-supervised learning (SSL)** on **3D medical imaging** data.
26
 
27
- Each model was pre-trained using a particular SSL method on the [OpenMind Dataset](https://huggingface.co/datasets/AnonRes/OpenMind), a large-scale, standardized collection of public brain MRI datasets.
28
 
29
- **These models are not recommended to be used as-is for feature extraction.** Instead we recommend using the downstream fine-tuning frameworks for **segmentation** and **classification** adaptation, available in the [adaptation repository](https://github.com/TaWald/nnUNet).
30
- *While manual download is possible, we recommend using the auto-download feature of the fine-tuning repository by providing the repository URL on Hugging Face instead of a local checkpoint path.*
31
 
32
- ---
 
 
 
 
 
 
33
 
34
- ## Model Variants
35
 
36
- We release SSL checkpoints for two backbone architectures:
37
 
38
- - **ResEnc-L**: A CNN-based encoder [[a](https://arxiv.org/abs/2410.23132), [b](https://arxiv.org/abs/2404.09556)]
39
- - **Primus-M**: A transformer-based encoder [[Primus paper](https://arxiv.org/abs/2503.01835)]
40
 
41
- Each encoder has been pre-trained using one of the following SSL techniques:
 
 
 
 
 
 
42
 
43
- | Method | Description |
44
- |---------------|-------------|
45
- | [Volume Contrastive (VoCo)](https://arxiv.org/abs/2402.17300) | Contrastive pretraining method for 3D volumes |
46
- | [VolumeFusion (VF)](https://arxiv.org/abs/2306.16925) | Spatial volume fusion-based segmentation SSL method |
47
- | [Models Genesis (MG)](https://www.sciencedirect.com/science/article/pii/S1361841520302048) | Reconstruction and denoising based pretraining method |
48
- | [Masked Autoencoders (MAE)](https://openaccess.thecvf.com/content/CVPR2022/html/He_Masked_Autoencoders_Are_Scalable_Vision_Learners_CVPR_2022_paper) | Default reconstruction based pretraining method |
49
- | [Spark 3D (S3D)](https://arxiv.org/abs/2410.23132) | Sparse reconstruction based pretraining mehtod (CNN only) |
50
- | [SimMIM](https://openaccess.thecvf.com/content/CVPR2022/html/Xie_SimMIM_A_Simple_Framework_for_Masked_Image_Modeling_CVPR_2022_paper.html) | Simple masked reconstruction based pretraining method (TR only) |
51
- | [SwinUNETR SSL](https://arxiv.org/abs/2111.14791) | Rotation, Contrastive and Reconstruction based pre-training method. |
52
- | [SimCLR](https://arxiv.org/abs/2002.05709) | Transfer of 2D Contrastive learning baseline method to 3D |
 
1
  ---
 
2
  datasets:
3
  - AnonRes/OpenMind
4
+ license: cc-by-4.0
5
+ pipeline_tag: image-segmentation
6
+ library_name: nnunet
7
  tags:
8
  - medical
9
  ---
10
 
11
+ # OpenMind Benchmark: Primus-M (SwinUNETR SSL)
12
+
13
+ This repository hosts pre-trained checkpoints from the **OpenMind** benchmark, specifically for the **Primus-M** backbone.
14
 
15
+ - **Architecture Paper**: [Primus: Enforcing Attention Usage for 3D Medical Image Segmentation](https://huggingface.co/papers/2503.01835)
16
+ - **Benchmark Paper**: [An OpenMind for 3D medical vision self-supervised learning](https://arxiv.org/abs/2412.17041)
17
+ - **Codebase**: [MIC-DKFZ/nnUNet](https://github.com/MIC-DKFZ/nnUNet)
18
+ - **Pre-training Framework**: [MIC-DKFZ/nnssl](https://github.com/MIC-DKFZ/nnssl)
19
+ - **Dataset**: [AnonRes/OpenMind](https://huggingface.co/datasets/AnonRes/OpenMind)
20
 
21
  ---
22
 
 
24
 
25
  ## Overview
26
 
27
+ Primus and PrimusV2 are Transformer-centric segmentation architectures designed to maximize the effectiveness of Transformer blocks in 3D medical imaging, moving away from traditional hybrid CNN-Transformer designs. By leveraging high-resolution tokens and optimized positional embeddings, Primus competes with and often exceeds state-of-the-art CNNs across various benchmarks.
 
 
28
 
29
+ This specific checkpoint contains the **Primus-M** encoder pre-trained using the **SwinUNETR SSL** technique (rotation, contrastive, and reconstruction) on the OpenMind Dataset, a standardized collection of public brain MRI data.
30
 
31
+ **Note**: These models are intended for downstream fine-tuning. We recommend using the [adaptation repository](https://github.com/TaWald/nnUNet) or the main [nnU-Net](https://github.com/MIC-DKFZ/nnUNet) framework for segmentation tasks.
 
32
 
33
+ ## Usage
34
+
35
+ The model is compatible with the `nnunetv2` framework. To install:
36
+
37
+ ```bash
38
+ pip install nnunetv2
39
+ ```
40
 
41
+ For detailed instructions on using Primus within nnU-Net, please refer to the [official documentation](https://github.com/MIC-DKFZ/nnUNet/blob/master/documentation/primus.md).
42
 
43
+ ## Citation
44
 
45
+ If you use this model or the Primus architecture, please cite:
 
46
 
47
+ ```bibtex
48
+ @article{wald2025primus,
49
+ title={Primus: Enforcing Attention Usage for 3D Medical Image Segmentation},
50
+ author={Wald, Tassilo and Roy, Saikat and Isensee, Fabian and Ulrich, Constantin and Ziegler, Sebastian and Trofimova, Dasha and Stock, Raphael and Baumgartner, Michael and Köhler, Gregor and Maier-Hein, Klaus},
51
+ journal={arXiv preprint arXiv:2503.01835},
52
+ year={2025}
53
+ }
54
 
55
+ @article{wald2024openmind,
56
+ title={An OpenMind for 3D medical vision self-supervised learning},
57
+ author={Wald, Tassilo and Ulrich, Constantin and Suprijadi, Justin and Ziegler, Sebastian and Nohel, Michael and Peretzke, Richard and others},
58
+ journal={arXiv preprint arXiv:2412.17041},
59
+ year={2024}
60
+ }
61
+ ```