Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mlr-org/mlr3extralearners
Extra learners for use in mlr3.
https://github.com/mlr-org/mlr3extralearners
Last synced: 1 day ago
JSON representation
Extra learners for use in mlr3.
- Host: GitHub
- URL: https://github.com/mlr-org/mlr3extralearners
- Owner: mlr-org
- License: lgpl-3.0
- Created: 2020-08-10T10:37:48.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-16T12:35:30.000Z (15 days ago)
- Last Synced: 2024-12-16T13:42:27.061Z (15 days ago)
- Language: R
- Homepage: https://mlr3extralearners.mlr-org.com/
- Size: 87.3 MB
- Stars: 93
- Watchers: 5
- Forks: 51
- Open Issues: 26
-
Metadata Files:
- Readme: README.Rmd
- Changelog: NEWS.md
- License: LICENSE
Awesome Lists containing this project
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
cache = FALSE,
collapse = TRUE,
comment = "#>",
echo = TRUE
)
library(mlr3extralearners)
library(magrittr)
```
# mlr3extralearners
Package website: [release](https://mlr3extralearners.mlr-org.com/) \|
[dev](https://mlr3extralearners.mlr-org.com/dev/)
Extra Learners for **[mlr3](https://github.com/mlr-org/mlr3/)**.
[](https://github.com/mlr-org/mlr3extralearners/actions/workflows/rcmdcheck.yml)
[](https://stackoverflow.com/questions/tagged/mlr3)
[](https://lmmisld-lmu-stats-slds.srv.mwn.de/mlr_invite/)
## What is mlr3extralearners?
`mlr3extralearners` contains all learners from mlr3 that are not in `mlr3learners` or the core packages.
An overview of all learners within the `mlr3verse` can be found [here](https://mlr-org.com/learners.html).
`mlr3extralearners` lives on GitHub and will not be on CRAN.
You can install the package as follows:
```{r, eval = FALSE}
# latest GitHub release
remotes::install_github("mlr-org/mlr3extralearners@*release")
# development version
remotes::install_github("mlr-org/mlr3extralearners")
```
Alternatively, you can add the following to your .Rprofile, which allows you to install `mlr3extralearners` via `install.packages()`.
Note that this will install the development version.
```{r, eval = FALSE}
# .Rprofile
options(repos = c(
mlrorg = "https://mlr-org.r-universe.dev",
CRAN = "https://cloud.r-project.org/"
))
```
## Installing and Loading Learners
The package includes functionality for detecting if you have the required packages installed
to use a learner, and ships with the function `install_learner` which can install all required
learner dependencies.
```{r, echo=TRUE, eval = FALSE}
lrn("regr.gbm")
#> Warning: Package 'gbm' required but not installed for Learner 'regr.gbm'
#> : Gradient Boosting
#> * Model: -
#> * Parameters: keep.data=FALSE, n.cores=1
#> * Packages: mlr3, mlr3extralearners, gbm
#> * Predict Types: [response]
#> * Feature Types: integer, numeric, factor, ordered
#> * Properties: importance, missings, weights
install_learners("regr.gbm")
lrn("regr.gbm")
#> : Gradient Boosting
#> * Model: -
#> * Parameters: keep.data=FALSE, n.cores=1
#> * Packages: mlr3, mlr3extralearners, gbm
#> * Predict Types: [response]
#> * Feature Types: integer, numeric, factor, ordered
#> * Properties: importance, missings, weights
```
## Extending mlr3extralearners
An in-depth tutorial on how to add learners can be found in the [package website](https://mlr3extralearners.mlr-org.com/articles/extending.html).