Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README with coverage #6

Merged
merged 1 commit into from
Oct 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 4 additions & 12 deletions .github/workflows/test_build_release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -44,20 +44,12 @@ jobs:
- name: Run tests with coverage
continue-on-error: true
run: |
poetry run pytest --cov=fpboost --cov-report=xml --cov-report=html --junitxml=reports/test-results.xml
poetry run pytest --cov=fpboost --cov-report=xml

- name: Upload coverage report
if: ${{ matrix.python-version == '3.12' }}
uses: actions/upload-artifact@v4
- name: Upload results to Codecov
uses: codecov/codecov-action@v4
with:
name: coverage-report
path: htmlcov/

- name: Upload test results
uses: actions/upload-artifact@v4
with:
name: test-results-${{ matrix.python-version }}
path: reports/
token: ${{ secrets.CODECOV_TOKEN }}

# Build job
build:
Expand Down
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# FPBoost: Fully Parametric Gradient Boosting for Survival Analysis

![CI Status](https://github.com/archettialberto/fpboost/workflows/Test%2C%20Build%20and%20Release%20to%20Pypi/badge.svg)
[![codecov](https://codecov.io/gh/{{REPOSITORY}}/branch/main/graph/badge.svg)](https://codecov.io/gh/{{REPOSITORY}})
![License Banner](https://img.shields.io/badge/License-MIT-purple.svg)
![Black Banner](https://img.shields.io/badge/code%20style-black-000000.svg)

Expand All @@ -13,6 +15,14 @@ integration into existing workflows.

## 📦 Installation

### From PyPI

To install FPBoost from PyPI, run the following command:

```bash
pip install fpboost
```

### From Source

To install the latest version of FPBoost from source, clone the repository and follow these steps:
Expand Down Expand Up @@ -74,10 +84,6 @@ c_index = concordance_index_censored(
print("Concordance Index:", c_index[0])
```

## 📖 Documentation

For detailed usage instructions and API reference, please refer to the [FPBoost Documentation]().

## 📚 How to Cite

If you use FPBoost in your research, please cite our paper:
Expand Down
Loading