Skip to contents

Cox-Time survival model. Calls survivalmodels::coxtime() from package 'survivalmodels'.

Dictionary

This Learner can be instantiated via the dictionary mlr_learners or with the associated sugar function lrn():

mlr_learners$get("surv.coxtime")
lrn("surv.coxtime")

Meta Information

Parameters

IdTypeDefaultLevelsRange
fracnumeric0\([0, 1]\)
standardize_timelogicalFALSETRUE, FALSE-
log_durationlogicalFALSETRUE, FALSE-
with_meanlogicalTRUETRUE, FALSE-
with_stdlogicalTRUETRUE, FALSE-
num_nodesuntypedc , 32, 32-
batch_normlogicalTRUETRUE, FALSE-
dropoutnumeric-\([0, 1]\)
activationcharacterrelucelu, elu, gelu, glu, hardshrink, hardsigmoid, hardswish, hardtanh, relu6, leakyrelu, ...-
deviceuntyped--
shrinknumeric0\([0, \infty)\)
optimizercharacteradamadadelta, adagrad, adam, adamax, adamw, asgd, rmsprop, rprop, sgd, sparse_adam-
rhonumeric0.9\((-\infty, \infty)\)
epsnumeric1e-08\((-\infty, \infty)\)
lrnumeric1\((-\infty, \infty)\)
weight_decaynumeric0\((-\infty, \infty)\)
learning_ratenumeric0.01\((-\infty, \infty)\)
lr_decaynumeric0\((-\infty, \infty)\)
betasuntypedc , 0.9 , 0.999-
amsgradlogicalFALSETRUE, FALSE-
lambdnumeric1e-04\([0, \infty)\)
alphanumeric0.75\([0, \infty)\)
t0numeric1e+06\((-\infty, \infty)\)
momentumnumeric0\((-\infty, \infty)\)
centeredlogicalTRUETRUE, FALSE-
etasuntypedc , 0.5, 1.2-
step_sizesuntypedc , 1e-06, 50-
dampeningnumeric0\((-\infty, \infty)\)
nesterovlogicalFALSETRUE, FALSE-
batch_sizeinteger256\((-\infty, \infty)\)
epochsinteger1\([1, \infty)\)
verboselogicalTRUETRUE, FALSE-
num_workersinteger0\((-\infty, \infty)\)
shufflelogicalTRUETRUE, FALSE-
best_weightslogicalFALSETRUE, FALSE-
early_stoppinglogicalFALSETRUE, FALSE-
min_deltanumeric0\((-\infty, \infty)\)
patienceinteger10\((-\infty, \infty)\)

Installation

Package 'survivalmodels' is not on CRAN and has to be install from GitHub via remotes::install_github("RaphaelS1/survivalmodels").

References

Kvamme, Håvard, Borgan Ø, Scheel I (2019). “Time-to-event prediction with neural networks and Cox regression.” arXiv preprint arXiv:1907.00825.

See also

Author

RaphaelS1

Super classes

mlr3::Learner -> mlr3proba::LearnerSurv -> LearnerSurvCoxtime

Methods

Inherited methods


Method new()

Creates a new instance of this R6 class.

Usage


Method clone()

The objects of this class are cloneable with this method.

Usage

LearnerSurvCoxtime$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

learner = mlr3::lrn("surv.coxtime")
print(learner)
#> <LearnerSurvCoxtime:surv.coxtime>: Cox-Time Estimator
#> * Model: -
#> * Parameters: list()
#> * Packages: mlr3, mlr3proba, mlr3extralearners, survivalmodels, distr6,
#>   reticulate
#> * Predict Type: crank
#> * Feature types: integer, numeric
#> * Properties: -

# available parameters:
learner$param_set$ids()
#>  [1] "frac"             "standardize_time" "log_duration"     "with_mean"       
#>  [5] "with_std"         "num_nodes"        "batch_norm"       "dropout"         
#>  [9] "activation"       "device"           "shrink"           "optimizer"       
#> [13] "rho"              "eps"              "lr"               "weight_decay"    
#> [17] "learning_rate"    "lr_decay"         "betas"            "amsgrad"         
#> [21] "lambd"            "alpha"            "t0"               "momentum"        
#> [25] "centered"         "etas"             "step_sizes"       "dampening"       
#> [29] "nesterov"         "batch_size"       "epochs"           "verbose"         
#> [33] "num_workers"      "shuffle"          "best_weights"     "early_stopping"  
#> [37] "min_delta"        "patience"