Skip to content

Commit dab6a59

Browse files
committed
Update to the readme [skip ci]
1 parent 1f4faaf commit dab6a59

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![License](https://img.shields.io/badge/License-BSD%202--Clause-orange.svg)](https://opensource.org/licenses/BSD-2-Clause)
44
[![](https://img.shields.io/badge/python-3.8|3.9|3.10|3.11|3.12-blue.svg)](https://www.python.org/downloads/)
55
[![Paper](https://zenodo.org/badge/DOI/10.3389/fneur.2022.932219.svg)](https://www.frontiersin.org/articles/10.3389/fneur.2022.932219/full)
6-
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/gist/dbouget/4ebb25b139383e8ac87d1ef910098184/compute_validation_example.ipynb)
6+
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/gist/dbouget/7560fe410db03e384a45ddc77bbe9a57/compute_validation_example.ipynb)
77

88
The code corresponds to the Raidionics backend for running the k-fold cross-validation and metrics computation.
99
The module can either be used as a Python library, as CLI, or as Docker container.
@@ -14,16 +14,30 @@ The module can either be used as a Python library, as CLI, or as Docker containe
1414
pip install git+https://github.com/dbouget/validation_metrics_computation.git
1515
```
1616

17-
## [Continuous integration](https://github.com/dbouget/validation_metrics_computation#continuous-integration)
17+
## [Continuous integration and notebooks](https://github.com/dbouget/validation_metrics_computation#continuous-integration-and-notebooks)
18+
19+
<div style="display: flex;">
20+
<div style="flex: 1; margin-right: 20px;">
1821

1922
| Operating System | Status |
2023
|------------------|--------------------------------------------------------------------------------------------------------------------|
2124
| **Windows** | [![Build macOS](https://github.com/dbouget/validation_metrics_computation/actions/workflows/build_windows.yml/badge.svg)](https://github.com/dbouget/validation_metrics_computation/actions/workflows/build_windows.yml) |
2225
| **Ubuntu** | [![Build macOS](https://github.com/dbouget/validation_metrics_computation/actions/workflows/build_ubuntu.yml/badge.svg)](https://github.com/dbouget/validation_metrics_computation/actions/workflows/build_ubuntu.yml) |
2326
| **macOS** | [![Build macOS](https://github.com/dbouget/validation_metrics_computation/actions/workflows/build_macos.yml/badge.svg)](https://github.com/dbouget/validation_metrics_computation/actions/workflows/build_macos.yml) |
2427
| **macOS ARM** | [![Build macOS](https://github.com/dbouget/validation_metrics_computation/actions/workflows/build_macos_arm.yml/badge.svg)](https://github.com/dbouget/validation_metrics_computation/actions/workflows/build_macos_arm.yml) |
28+
</div>
29+
<div style="flex: 1;">
30+
31+
| Notebook | Colab | Github |
32+
|----------------|-------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|
33+
| **Validation** | <a href="https://colab.research.google.com/gist/dbouget/7560fe410db03e384a45ddc77bbe9a57/compute_validation_example.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | [![View on GitHub](https://img.shields.io/badge/View%20on%20GitHub-blue?logo=github)](https://github.com/dbouget/validation_metrics_computation/blob/master/notebooks/compute_validation_example.ipynb) |
34+
| **Study** | <a href="https://colab.research.google.com/gist/dbouget/8a0e093284688e993244930bd36fd367/compute_study_example.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | [![View on GitHub](https://img.shields.io/badge/View%20on%20GitHub-blue?logo=github)](https://github.com/dbouget/validation_metrics_computation/blob/master/notebooks/compute_study_example.ipynb) |
35+
36+
</div>
37+
</div>
2538

2639
## [How to cite](https://github.com/dbouget/validation_metrics_computation#how-to-cite)
40+
2741
If you are using Raidionics in your research, please cite the following references.
2842

2943
For segmentation validation and metrics computation:
@@ -58,9 +72,6 @@ The final software including updated performance metrics for preoperative tumors
5872
In the following, a description of how the data should be organized on disk is provided, and a test dataset can
5973
be downloaded [here](https://github.com/raidionics/Raidionics-models/releases/download/1.2.0/Samples-RaidionicsValLib_UnitTest1.zip).
6074

61-
A detailed interactive demo on how to load and work with the data can be seen on CoLab, simply click the CoLab badge <a href="https://colab.research.google.com/gist/dbouget/4ebb25b139383e8ac87d1ef910098184/compute_validation_example.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> to see the notebook.
62-
Alternatively click [here](https://github.com/dbouget/validation_metrics_computation/blob/master/notebooks/compute_validation_example.ipynb) to see it on GitHub.
63-
6475
<details>
6576
<summary>
6677

0 commit comments

Comments
 (0)