Update model card with Primus paper and segmentation tag

#1
by nielsr HF Staff - opened
Files changed (1) hide show
  1. README.md +51 -20
README.md CHANGED
@@ -1,18 +1,20 @@
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,23 +22,18 @@ 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
 
@@ -45,8 +42,42 @@ Each encoder has been pre-trained using one of the following SSL techniques:
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
+ - 3d
10
  ---
11
 
12
+ # OpenMind Benchmark 3D SSL Models (Primus)
13
 
14
+ This repository hosts pre-trained checkpoints from the **OpenMind** benchmark, including the **Primus** architecture introduced in:
15
+
16
+ 📄 **Primus: Enforcing Attention Usage for 3D Medical Image Segmentation** (Wald, T., Roy, S., Isensee, F., Ulrich, C., Ziegler, S., Trofimova, D., ... & Maier-Hein, K. H. (2025).)
17
+ [[Paper](https://huggingface.co/papers/2503.01835)] | [[Code](https://github.com/MIC-DKFZ/nnUNet)]
18
 
19
  ---
20
 
 
22
 
23
  ## Overview
24
 
25
+ 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.
 
 
26
 
27
+ Primus is a Transformer-centric segmentation architecture designed to overcome the limitations of hybrid CNN-Transformer models by leveraging high-resolution tokens and iterative patch embeddings.
28
 
29
+ **Note:** These models are primarily intended for downstream fine-tuning. We recommend using the [adaptation repository](https://github.com/MIC-DKFZ/nnUNet) based on **nnU-Net**.
 
 
 
30
 
31
  ## Model Variants
32
 
33
  We release SSL checkpoints for two backbone architectures:
34
 
35
+ - **ResEnc-L**: A CNN-based encoder.
36
+ - **Primus-M**: A transformer-based encoder introduced in the [Primus paper](https://huggingface.co/papers/2503.01835).
37
 
38
  Each encoder has been pre-trained using one of the following SSL techniques:
39
 
 
42
  | [Volume Contrastive (VoCo)](https://arxiv.org/abs/2402.17300) | Contrastive pretraining method for 3D volumes |
43
  | [VolumeFusion (VF)](https://arxiv.org/abs/2306.16925) | Spatial volume fusion-based segmentation SSL method |
44
  | [Models Genesis (MG)](https://www.sciencedirect.com/science/article/pii/S1361841520302048) | Reconstruction and denoising based pretraining method |
45
+ | [Masked Autoencoders (MAE)](https://arxiv.org/abs/2111.06377) | Default reconstruction based pretraining method |
46
+ | [Spark 3D (S3D)](https://arxiv.org/abs/2410.23132) | Sparse reconstruction based pretraining method (CNN only) |
47
+ | [SimMIM](https://arxiv.org/abs/2111.09886) | Simple masked reconstruction based pretraining method (TR only) |
48
  | [SwinUNETR SSL](https://arxiv.org/abs/2111.14791) | Rotation, Contrastive and Reconstruction based pre-training method. |
49
  | [SimCLR](https://arxiv.org/abs/2002.05709) | Transfer of 2D Contrastive learning baseline method to 3D |
50
+
51
+ ## Usage
52
+
53
+ To use these models for segmentation adaptation, install `nnunetv2`:
54
+
55
+ ```bash
56
+ pip install nnunetv2
57
+ ```
58
+
59
+ For detailed instructions on using the checkpoints for downstream tasks, please refer to the [nnU-Net documentation](https://github.com/MIC-DKFZ/nnUNet/blob/master/documentation/primus.md).
60
+
61
+ ## Citation
62
+
63
+ If you use Primus, please cite:
64
+
65
+ ```text
66
+ @article{wald2025primus,
67
+ title={Primus: Enforcing Attention Usage for 3D Medical Image Segmentation},
68
+ 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},
69
+ journal={arXiv preprint arXiv:2503.01835},
70
+ year={2025}
71
+ }
72
+ ```
73
+
74
+ For the OpenMind benchmark:
75
+
76
+ ```text
77
+ @article{wald2024openmind,
78
+ title={An OpenMind for 3D medical vision self-supervised learning},
79
+ author={Wald, Tassilo and Ulrich, Constantin and Suprijadi, J. and Ziegler, Sebastian and others},
80
+ journal={arXiv preprint arXiv:2412.17041},
81
+ year={2024}
82
+ }
83
+ ```