Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mlr-org/mlr3learners.template
Learner from package {<package>} for mlr3
https://github.com/mlr-org/mlr3learners.template
Last synced: about 2 months ago
JSON representation
Learner from package {<package>} for mlr3
- Host: GitHub
- URL: https://github.com/mlr-org/mlr3learners.template
- Owner: mlr-org
- Created: 2019-07-14T16:22:22.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-06-03T19:59:59.000Z (over 4 years ago)
- Last Synced: 2024-05-01T09:37:22.264Z (8 months ago)
- Language: R
- Homepage:
- Size: 88.9 KB
- Stars: 5
- Watchers: 4
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# mlr3learners.template
This packages provides a template for adding new learners for [mlr3](https://mlr3.mlr-org.com).
Creating new learners is covered in detail in section ["Adding new learners"](https://mlr3book.mlr-org.com/extending-learners.html) in the mlr3book.
This package serves as a starting point for learners to share with others.
## Instructions
This repository is a template repository to create a learner that aligns with existing mlr3 learners.
Perform the following tasks to create your learner:
1. Replace all instances of
1. `` with the name of the underlying package.
1. `` with the learner type, e.g. `Classif` or `Regr`.
1. `` with the name of the algorithm, e.g `randomForest`.
1. Rename files following the same scheme as in 1).
1. Check if the learner supports feature importance internally.
If yes, add a `importance()` method in the respective learner class.
1. Check if the learner supports out-of-bag error estimation internally.
If yes, add a `oob_error()` method in the respective learner class.
1. Add yourself as the maintainer in `DESCRIPTION`.
1. Set up Continuous Integration (CI).
The GitHub Actions YAML files live in `.github/workflows`.
1. Replace `` in l.17 of `tic.R` with the name of the package.
1. Update the "Paramtest" files in `inst/paramtest/` to ensure no parameter was forgotten in the learner.
Make sure that the CI test passes for "Param Check".
1. Update the badge in `README.md` with the package name.
1. Run `devtools::document(roclets = c('rd', 'collate', 'namespace'))` to create the NAMESPACE and man/ files.
1. Leave the files in `man-roxygen` as they are - they will just work.
1. Run `usethis::use_tidy_description()` to format `DESCRIPTION`.
1. Test your learner locally by running `devtools::test()`
1. Check your package by running `rcmdcheck::rcmdcheck()`
1. Check if your learner complies with the [mlr style guide](https://github.com/mlr-org/mlr3/wiki/Style-Guide).
1. Ensure that the CI builds complete successfully (via the "Actions" menu in the repo).
1. Check on last small details like the name of the learner package and for possible leftovers of the placeholders used in the template.
Last but not least go through
:point_right: [this checklist](https://github.com/mlr-org/mlr3learners.template/issues/5) :page_facing_up:
to make sure your learner is ready for review.
After your learner is accepted, it can be added to [mlr3learners.drat](https://github.com/mlr3learners/mlr3learners.drat), making it installabe via the canonical `install.packages()` function without the need to live on CRAN.
**Resources for adding a new learner (summary)**
- [mlr3learners.template](https://github.com/mlr-org/mlr3learners.template)
- [mlr3book section "Adding new learners" including FAQ](https://mlr3book.mlr-org.com/extending-learners.html)
- [Checklist prior to requesting a review](https://github.com/mlr-org/mlr3learners.template/issues/5)
**!Important!**: Delete all instructions up to this point and just leave the part below.
# mlr3learners.\
[](https://github.com/mlr3learners/mlr3learners./actions)
[](https://github.com/mlr3learners/mlr3learners./actions)
[](https://codecov.io/gh/mlr3learners/mlr3learners.)
[](https://stackoverflow.com/questions/tagged/mlr3)
Adds `` and `` from the {} package to {mlr3}.
Install the latest release of the package via
```r
install.packages("mlr3learners.")
```
by following the instructions in the [mlr3learners.drat README](https://github.com/mlr3learners/mlr3learners.drat).
Alternatively, you can install the latest version of {mlr3learners.} from Github with:
```r
remotes::install_github("mlr3learners/mlr3learners.")
```