Skip to content

Commit 1e11c7f

Browse files
committed
add competing risks info in the README
1 parent 606d23f commit 1e11c7f

File tree

2 files changed

+31
-25
lines changed

2 files changed

+31
-25
lines changed

README.Rmd

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ Probabilistic Supervised Learning for **[mlr3](https://github.com/mlr-org/mlr3/)
2525

2626
## What is mlr3proba?
2727

28-
`mlr3proba` is a machine learning toolkit for making probabilistic predictions within the **[mlr3](https://github.com/mlr-org/mlr3)** ecosystem.
29-
It currently supports the following tasks:
28+
`mlr3proba` is a machine learning toolkit for **probabilistic supervised learning** within the **[mlr3](https://github.com/mlr-org/mlr3)** ecosystem.
3029

31-
1. **Predictive survival analysis**: survival analysis where individual hazards and survival distributions can be queried.
32-
2. **Unconditional distribution estimation**: main returned output is the distribution.
33-
Sub-cases are density estimation and unconditional survival estimation.
30+
It currently supports:
31+
32+
1. **Predictive survival analysis**: with support for right-censoring single-event and competing risks.
33+
2. **Unconditional distribution estimation**: including density and unconditional survival estimation.
3434
3. **Probabilistic supervised regression**: Supervised regression with a predictive distribution as the return type.
3535

3636
The survival analysis part is considered in a mature state, the rest are in early stages of development.
@@ -39,7 +39,7 @@ The survival analysis part is considered in a mature state, the rest are in earl
3939

4040
Key features of `mlr3proba` focus on survival analysis and are:
4141

42-
- Task frameworks for survival analysis (`TaskSurv`)
42+
- Task frameworks for survival analysis (`TaskSurv`, `TaskCompetingRisks`)
4343
- A comprehensive **selection of survival learners** (mostly via
4444
[mlr3extralearners](https://github.com/mlr-org/mlr3extralearners/))
4545
- A unified `$train()`/`$predict()` model interface to any probabilistic predictive model (frequentist, Bayesian, Deep Learning, or other)
@@ -69,16 +69,17 @@ remotes::install_github("mlr-org/mlr3proba")
6969

7070
## Learners
7171

72-
- [Core learners](https://mlr3proba.mlr-org.com/reference/index.html#survival-learners) are implemented in `mlr3proba` and include the Kaplan-Meier Estimator, the Cox Proportional Hazards model and the Survival Tree learner.
73-
- In [mlr3extralearners](https://github.com/mlr-org/mlr3extralearners) we have interfaced several advanced ML survival learners.
72+
- [Core learners](https://mlr3proba.mlr-org.com/reference/index.html#survival-learners) are implemented in `mlr3proba` and include the Kaplan-Meier Estimator, the Cox Proportional Hazards model, the Survival Tree learner and the Aalen-Johansen estimator for competing risks.
73+
- In [mlr3extralearners](https://github.com/mlr-org/mlr3extralearners) we have interfaced several more advanced ML learners.
7474
Use the [interactive search table](https://mlr-org.com/learners.html) to search for the available survival learners and see the [learner status page](https://mlr3extralearners.mlr-org.com/articles/learner_status.html) for their live status.
7575

7676
## Measures
7777

7878
For density estimation and probabilistic regression only the **log-loss** is currently implemented.
79-
For survival analysis, see full list [here](https://mlr3proba.mlr-org.com/reference/index.html#survival-measures).
79+
For competing risk, see list [here](https://mlr3proba.mlr-org.com/reference/index.html#competing-risk-measures).
80+
For survival analysis, see list [here](https://mlr3proba.mlr-org.com/reference/index.html#survival-measures).
8081

81-
Some commonly used measures are the following:
82+
Some commonly used measures for right-censored single-event tasks are the following:
8283

8384
| ID | Measure | Package | Category | Prediction Type
8485
| :--| :------ | :------ | :------ | :------- |

README.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,16 @@ Discussions](https://img.shields.io/github/discussions/mlr-org/mlr3proba?logo=gi
1818

1919
## What is mlr3proba?
2020

21-
`mlr3proba` is a machine learning toolkit for making probabilistic
22-
predictions within the **[mlr3](https://github.com/mlr-org/mlr3)**
23-
ecosystem. It currently supports the following tasks:
24-
25-
1. **Predictive survival analysis**: survival analysis where individual
26-
hazards and survival distributions can be queried.
27-
2. **Unconditional distribution estimation**: main returned output is
28-
the distribution. Sub-cases are density estimation and unconditional
29-
survival estimation.
21+
`mlr3proba` is a machine learning toolkit for **probabilistic supervised
22+
learning** within the **[mlr3](https://github.com/mlr-org/mlr3)**
23+
ecosystem.
24+
25+
It currently supports:
26+
27+
1. **Predictive survival analysis**: with support for right-censoring
28+
single-event and competing risks.
29+
2. **Unconditional distribution estimation**: including density and
30+
unconditional survival estimation.
3031
3. **Probabilistic supervised regression**: Supervised regression with
3132
a predictive distribution as the return type.
3233

@@ -37,7 +38,8 @@ in early stages of development.
3738

3839
Key features of `mlr3proba` focus on survival analysis and are:
3940

40-
- Task frameworks for survival analysis (`TaskSurv`)
41+
- Task frameworks for survival analysis (`TaskSurv`,
42+
`TaskCompetingRisks`)
4143
- A comprehensive **selection of survival learners** (mostly via
4244
[mlr3extralearners](https://github.com/mlr-org/mlr3extralearners/))
4345
- A unified `$train()`/`$predict()` model interface to any probabilistic
@@ -81,9 +83,10 @@ remotes::install_github("mlr-org/mlr3proba")
8183
- [Core
8284
learners](https://mlr3proba.mlr-org.com/reference/index.html#survival-learners)
8385
are implemented in `mlr3proba` and include the Kaplan-Meier Estimator,
84-
the Cox Proportional Hazards model and the Survival Tree learner.
86+
the Cox Proportional Hazards model, the Survival Tree learner and the
87+
Aalen-Johansen estimator for competing risks.
8588
- In [mlr3extralearners](https://github.com/mlr-org/mlr3extralearners)
86-
we have interfaced several advanced ML survival learners. Use the
89+
we have interfaced several more advanced ML learners. Use the
8790
[interactive search table](https://mlr-org.com/learners.html) to
8891
search for the available survival learners and see the [learner status
8992
page](https://mlr3extralearners.mlr-org.com/articles/learner_status.html)
@@ -92,11 +95,13 @@ remotes::install_github("mlr-org/mlr3proba")
9295
## Measures
9396

9497
For density estimation and probabilistic regression only the
95-
**log-loss** is currently implemented. For survival analysis, see full
96-
list
98+
**log-loss** is currently implemented. For competing risk, see list
99+
[here](https://mlr3proba.mlr-org.com/reference/index.html#competing-risk-measures).
100+
For survival analysis, see list
97101
[here](https://mlr3proba.mlr-org.com/reference/index.html#survival-measures).
98102

99-
Some commonly used measures are the following:
103+
Some commonly used measures for right-censored single-event tasks are
104+
the following:
100105

101106
| ID | Measure | Package | Category | Prediction Type |
102107
|:---|:---|:---|:---|:---|

0 commit comments

Comments
 (0)