Merge pull request #11 from BrainLesion/fix-broken-readme

Fix codecov report in action and add codecov badge

.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

README.md

@@ -2,10 +2,10 @@
 
 [![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)
-<!-- [![codecov](https://codecov.io/gh/BrainLesion/deep_quality_estimation/graph/badge.svg?token=A7FWUKO9Y4)](https://codecov.io/gh/BrainLesion/deep_quality_estimation) -->
 
 Quality prediction for brain tumor segmentation on a scale ranging from &#x2B50; 1 star to  &#x2B50;&#x2B50;&#x2B50;&#x2B50;&#x2B50;&#x2B50; 6 stars inspired by the paper [**Deep Quality Estimation: Creating Surrogate Models for Human Quality Ratings**](https://arxiv.org/abs/2205.10355).  <br>
 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.
@@ -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
 ```