Providing the top performing algorithms from the Brain Tumor Segmentation (BraTS) challenges, through an easy to use Python API powered by docker.
- Access to top-performing algorithms from recent BraTS challenges
- Easy-to-use minimal API
- Extensive documentation and examples
With a Python 3.8+ environment, you can install brats
directly from PyPI:
pip install brats
To run brats
you need a working Docker installation.
Most algorithms also require GPU support (NVIDIA Docker).
Installation instructions:
- Docker: Installation instructions on the official website
- NVIDIA Container Toolkit: Refer to the NVIDIA install guide and the official GitHub page
A minimal example to create a segmentation could look like this:
from brats import AdultGliomaSegmenter
from brats.utils.constants import AdultGliomaAlgorithms
segmenter = AdultGliomaSegmenter(algorithm=AdultGliomaAlgorithms.BraTS23_1, cuda_devices="0")
# these parameters are optional, by default the winning algorithm will be used on cuda:0
segmenter.infer_single(
t1c="path/to/t1c.nii.gz",
t1n="path/to/t1n.nii.gz",
t2f="path/to/t2f.nii.gz",
t2w="path/to/t2w.nii.gz",
output_file="segmentation.nii.gz",
)
For more examples and details please refer to our extensive Notebook tutorials here NBViewer (GitHub). For the best experience open the notebook in Colab.
Adult Glioma Segmentation
Class: brats.AdultGliomaSegmenter
(Docs)
Year | Rank | Author | Paper | CPU Support | Key Enum |
---|---|---|---|---|---|
2023 | 1st | André Ferreira, et al. | Link | ❌ | BraTS23_1 |
2023 | 2nd | Andriy Myronenko, et al. | N/A | ❌ | BraTS23_2 |
2023 | 3rd | Fadillah Adamsyah Maani, et al. | N/A | ❌ | BraTS23_3 |
BraTS-Africa Segmentation
Class: brats.AfricaSegmenter
(Docs)
Year | Rank | Author | Paper | CPU Support | Key Enum |
---|---|---|---|---|---|
2023 | 1st | Andriy Myronenko, et al. | TODO | ❌ | BraTS23_1 |
2023 | 2nd | Alyssa R Amod, et al. | N/A | ❌ | BraTS23_2 |
2023 | 3rd | Ziyan Huang, et al. | N/A | ✅ | BraTS23_3 |
Meningioma Segmentation
Class: brats.MeningiomaSegmenter
(Docs)
Year | Rank | Author | Paper | CPU Support | Key Enum |
---|---|---|---|---|---|
2023 | 1st | Andriy Myronenko, et al. | N/A | ❌ | BraTS23_1 |
2023 | 2nd | Ziyan Huang, et al. | N/A | ✅ | BraTS23_2 |
2023 | 3rd | Zhifan Jiang et al. | N/A | ❌ | BraTS23_3 |
Brain Metastases Segmentation
Class: brats.MetastasesSegmenter
(Docs)
Year | Rank | Author | Paper | CPU Support | Key Enum |
---|---|---|---|---|---|
2023 | 1st | Andriy Myronenko, et al. | N/A | ❌ | BraTS23_1 |
2023 | 2nd | Siwei Yang, et al. | N/A | ❌ | BraTS23_2 |
2023 | 3rd | Ziyan Huang, et al. | N/A | ✅ | BraTS23_3 |
Pediatric Segmentation
Class: brats.PediatricSegmenter
(Docs)
Year | Rank | Author | Paper | CPU Support | Key Enum |
---|---|---|---|---|---|
2023 | 1st | Zhifan Jiang et al. | N/A | ❌ | BraTS23_1 |
2023 | 2nd | Andriy Myronenko, et al. | N/A | ❌ | BraTS23_2 |
2023 | 3rd | Yubo Zhou | N/A | ❌ | BraTS23_3 |
Inpainting
Class: brats.Inpainter
(Docs)
Year | Rank | Author | Paper | CPU Support | Key Enum |
---|---|---|---|---|---|
2023 | 1st | Juexin Zhang, et al. | N/A | ✅ | BraTS23_1 |
2023 | 2nd | Alicia Durrer, et al. | N/A | ❌ | BraTS23_2 |
2023 | 3rd | Jiayu Huo, et al. | N/A | ✅ | BraTS23_3 |
If you use BraTS in your research, please cite it to support the development!
TODO: citation will be added asap
We welcome all kinds of contributions from the community!
Please open a new issue here.
Nice to have you on board! Please have a look at our CONTRIBUTING.md file.