Download R6 Package In R
Package website: release | dev
Efficient, object-oriented programming on the building blocks of machine learning. Successor of mlr.
Resources (for users and developers)
- We started writing a book. This should be the central entry point to the package.
- The mlr3gallery has some case studies and demonstrates how frequently occurring problems can be solved. It is still in early days so stay tuned for more to come.
- Reference manual
- FAQ
- Ask questions on [Stackoverflow (tag #mlr3)](https://stackoverflow.com/questions/tagged/mlr3)
- Extension Learners
- Recommended core regression, classification, and survival learners are in mlr3learners
- All others are in mlr3extralearners
- Use the learner search to get a simple overview
- Use the learner status to see their build status
- Cheatsheets
- Overview of cheatsheets
- mlr3
- mlr3tuning
- mlr3pipelines
- Videos:
- useR2019 talk on mlr3
- useR2019 talk on mlr3pipelines and mlr3tuning
- useR2020 tutorial on mlr3, mlr3tuning and mlr3pipelines
- Courses/Lectures
- The course Introduction to Machine learning (I2ML) is a free and open flipped classroom course on the basics of machine learning.
mlr3
is used in the demos and exercises.
- The course Introduction to Machine learning (I2ML) is a free and open flipped classroom course on the basics of machine learning.
- Templates/Tutorials
- mlr3-learndrake: Shows how to use mlr3 with drake for reproducible ML workflow automation.
- List of extension packages
- mlr-outreach contains public talks and slides resources.
- Our blog about mlr and mlr3. (We are not the most frequent bloggers ;) )
- Wiki: Contains mainly information for developers.
Installation
Install the last release from CRAN:
Install the development version from GitHub:
If you want to get started with mlr3
, we recommend installing the mlr3verse meta-package which installs mlr3
and some of the most important extension packages:
Example
Constructing Learners and Tasks
library ( mlr3 ) # create learning task task_penguins <- TaskClassif $ new (id = "penguins", backend = palmerpenguins :: penguins, target = "species" ) task_penguins
## <TaskClassif:penguins> (344 x 8) ## * Target: species ## * Properties: multiclass ## * Features (7): ## - int (3): body_mass_g, flipper_length_mm, year ## - dbl (2): bill_depth_mm, bill_length_mm ## - fct (2): island, sex
# load learner and set hyperparameter learner <- lrn ( "classif.rpart", cp = .01 )
Basic train + predict
# train/test split train_set <- sample ( task_penguins $ nrow, 0.8 * task_penguins $ nrow ) test_set <- setdiff ( seq_len ( task_penguins $ nrow ), train_set ) # train the model learner $ train ( task_penguins, row_ids = train_set ) # predict data prediction <- learner $ predict ( task_penguins, row_ids = test_set ) # calculate performance prediction $ confusion
## truth ## response Adelie Chinstrap Gentoo ## Adelie 32 2 0 ## Chinstrap 1 8 0 ## Gentoo 0 3 23
measure <- msr ( "classif.acc" ) prediction $ score ( measure )
## classif.acc ## 0.9130435
Resample
# automatic resampling resampling <- rsmp ( "cv", folds = 3L ) rr <- resample ( task_penguins, learner, resampling ) rr $ score ( measure )
## task task_id learner learner_id ## 1: <TaskClassif[49]> penguins <LearnerClassifRpart[37]> classif.rpart ## 2: <TaskClassif[49]> penguins <LearnerClassifRpart[37]> classif.rpart ## 3: <TaskClassif[49]> penguins <LearnerClassifRpart[37]> classif.rpart ## resampling resampling_id iteration prediction ## 1: <ResamplingCV[19]> cv 1 <PredictionClassif[20]> ## 2: <ResamplingCV[19]> cv 2 <PredictionClassif[20]> ## 3: <ResamplingCV[19]> cv 3 <PredictionClassif[20]> ## classif.acc ## 1: 0.8956522 ## 2: 0.9130435 ## 3: 0.9473684
## classif.acc ## 0.918688
Extension Packages
Consult the wiki for short descriptions and links to the respective repositories.
For beginners, we strongly recommend to install and load the mlr3verse package for a better user experience.
Why a rewrite?
mlr was first released to CRAN in 2013. Its core design and architecture date back even further. The addition of many features has led to a feature creep which makes mlr hard to maintain and hard to extend. We also think that while mlr was nicely extensible in some parts (learners, measures, etc.), other parts were less easy to extend from the outside. Also, many helpful R libraries did not exist at the time mlr was created, and their inclusion would result in non-trivial API changes.
Design principles
- Only the basic building blocks for machine learning are implemented in this package.
- Focus on computation here. No visualization or other stuff. That can go in extra packages.
- Overcome the limitations of R's S3 classes with the help of R6.
- Embrace R6 for a clean OO-design, object state-changes and reference semantics. This might be less "traditional R", but seems to fit
mlr
nicely. - Embrace
data.table
for fast and convenient data frame computations. - Combine
data.table
andR6
, for this we will make heavy use of list columns in data.tables. - Defensive programming and type safety. All user input is checked with
checkmate
. Return types are documented, and mechanisms popular in base R which "simplify" the result unpredictably (e.g.,sapply()
ordrop
argument in[.data.frame
) are avoided. - Be light on dependencies.
mlr3
requires the following packages at runtime:-
parallelly
: Helper functions for parallelization. No extra recursive dependencies. -
future.apply
: Resampling and benchmarking is parallelized with thefuture
abstraction interfacing many parallel backends. -
backports
: Ensures backward compatibility with older R releases. Developed by members of themlr
team. No recursive dependencies. -
checkmate
: Fast argument checks. Developed by members of themlr
team. No extra recursive dependencies. -
mlr3misc
: Miscellaneous functions used in multiple mlr3 extension packages. Developed by themlr
team. -
paradox
: Descriptions for parameters and parameter sets. Developed by themlr
team. No extra recursive dependencies. -
R6
: Reference class objects. No recursive dependencies. -
data.table
: Extension of R'sdata.frame
. No recursive dependencies. -
digest
(viamlr3misc
): Hash digests. No recursive dependencies. -
uuid
: Create unique string identifiers. No recursive dependencies. -
lgr
: Logging facility. No extra recursive dependencies. -
mlr3measures
: Performance measures. No extra recursive dependencies. -
mlbench
: A collection of machine learning data sets. No dependencies. -
palmerpenguins
: A classification data set about penguins, used on examples and provided as a toy task. No dependencies.
-
- Reflections: Objects are queryable for properties and capabilities, allowing you to program on them.
- Additional functionality that comes with extra dependencies:
- To capture output, warnings and exceptions,
evaluate
andcallr
can be used.
- To capture output, warnings and exceptions,
Contributing to mlr3
This R package is licensed under the LGPL-3. If you encounter problems using this software (lack of documentation, misleading or wrong documentation, unexpected behavior, bugs, …) or just want to suggest features, please open an issue in the issue tracker. Pull requests are welcome and will be included at the discretion of the maintainers.
Please consult the wiki for a style guide, a roxygen guide and a pull request guide.
Citing mlr3
If you use mlr3, please cite our JOSS article:
@Article{mlr3, title = {{mlr3}: A modern object-oriented machine learning framework in {R}}, author = {Michel Lang and Martin Binder and Jakob Richter and Patrick Schratz and Florian Pfisterer and Stefan Coors and Quay Au and Giuseppe Casalicchio and Lars Kotthoff and Bernd Bischl}, journal = {Journal of Open Source Software}, year = {2019}, month = {dec}, doi = {10.21105 /joss.01903}, url = {https: //joss.theoj.org/papers/ 10.21105 /joss.01903}, }
Source: https://mlr3.mlr-org.com/
Posted by: moore-people.blogspot.com