From 5537d74b691a0cdcbabe6bc211207e0924437a4f Mon Sep 17 00:00:00 2001 From: Marcel Rosier Date: Wed, 27 Nov 2024 11:38:06 +0100 Subject: [PATCH 1/2] Fix codecov report in action and add codecov badge --- .github/workflows/tests.yml | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index c5f097f..a170ae8 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -39,7 +39,7 @@ jobs: # TODO adapt package_name to the name of your package - name: Test with pytest run: | - python -m poetry run pytest --cov package_name + python -m poetry run pytest --cov deep_quality_estimation --cov-report=xml # Add the following block to upload coverage to Codecov, requires a CODECOV_TOKEN secret to be set in the repository # - name: Upload results to Codecov # # Only upload to Codecov after a merge to the main branch diff --git a/README.md b/README.md index fd08dee..477c94f 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,8 @@ [![Stable Version](https://img.shields.io/pypi/v/deep_quality_estimation?label=stable)](https://pypi.python.org/pypi/deep_quality_estimation/) [![Documentation Status](https://readthedocs.org/projects/deep_quality_estimation/badge/?version=latest)](http://deep_quality_estimation.readthedocs.io/?badge=latest) [![tests](https://github.com/BrainLesion/deep_quality_estimation/actions/workflows/tests.yml/badge.svg)](https://github.com/BrainLesion/deep_quality_estimation/actions/workflows/tests.yml) +[![codecov](https://codecov.io/gh/BrainLesion/deep_quality_estimation/graph/badge.svg?token=A7FWUKO9Y4)](https://codecov.io/gh/BrainLesion/deep_quality_estimation) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) - Quality prediction for brain tumor segmentation on a scale ranging from ⭐ 1 star to ⭐⭐⭐⭐⭐⭐ 6 stars inspired by the paper [**Deep Quality Estimation: Creating Surrogate Models for Human Quality Ratings**](https://arxiv.org/abs/2205.10355).
This can be used to estimate the quality of a BraTS glioma segmentation for evaluation purposes or, e.g., as part of a loss function during model training. From 21200d400bc0e1bc0856089679800d278c0f35e0 Mon Sep 17 00:00:00 2001 From: Marcel Rosier Date: Wed, 27 Nov 2024 14:44:27 +0100 Subject: [PATCH 2/2] Fix rtd badge link --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 477c94f..5efd1e5 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Python Versions](https://img.shields.io/pypi/pyversions/deep_quality_estimation)](https://pypi.org/project/deep_quality_estimation/) [![Stable Version](https://img.shields.io/pypi/v/deep_quality_estimation?label=stable)](https://pypi.python.org/pypi/deep_quality_estimation/) -[![Documentation Status](https://readthedocs.org/projects/deep_quality_estimation/badge/?version=latest)](http://deep_quality_estimation.readthedocs.io/?badge=latest) +[![Documentation Status](https://readthedocs.org/projects/deep_quality_estimation/badge/?version=latest)](https://deep-quality-estimation.readthedocs.io/en/latest/) [![tests](https://github.com/BrainLesion/deep_quality_estimation/actions/workflows/tests.yml/badge.svg)](https://github.com/BrainLesion/deep_quality_estimation/actions/workflows/tests.yml) [![codecov](https://codecov.io/gh/BrainLesion/deep_quality_estimation/graph/badge.svg?token=A7FWUKO9Y4)](https://codecov.io/gh/BrainLesion/deep_quality_estimation) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) @@ -61,7 +61,7 @@ mean_score, scores_per_view = dqe.predict( ## Citation -If you use deep_quality_estimation in your research, please cite it to support the development! +If you use `deep_quality_estimation` in your research, please cite it to support the development! https://arxiv.org/abs/2205.10355 ```