Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mlr-org/mlr3book
Online version of Bischl, B., Sonabend, R., Kotthoff, L., & Lang, M. (Eds.). (2024). "Applied Machine Learning Using mlr3 in R". CRC Press.
https://github.com/mlr-org/mlr3book
book bookdown machine-learning mlr3 r
Last synced: 7 days ago
JSON representation
Online version of Bischl, B., Sonabend, R., Kotthoff, L., & Lang, M. (Eds.). (2024). "Applied Machine Learning Using mlr3 in R". CRC Press.
- Host: GitHub
- URL: https://github.com/mlr-org/mlr3book
- Owner: mlr-org
- License: mit
- Created: 2019-02-27T13:09:05.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-18T12:57:42.000Z (3 months ago)
- Last Synced: 2024-10-19T13:05:11.355Z (3 months ago)
- Topics: book, bookdown, machine-learning, mlr3, r
- Language: TeX
- Homepage: https://mlr3book.mlr-org.com/
- Size: 796 MB
- Stars: 253
- Watchers: 15
- Forks: 59
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - mlr-org/mlr3book - Online version of Bischl, B., Sonabend, R., Kotthoff, L., & Lang, M. (Eds.). (2024). "Applied Machine Learning Using mlr3 in R". CRC Press. (TeX)
README
# mlr3book
[](https://github.com/mlr-org/mlr3book/actions?query=workflow%3Amlr3book)
[](https://stackoverflow.com/questions/tagged/mlr3)
[](https://lmmisld-lmu-stats-slds.srv.mwn.de/mlr_invite/)
Repository to build the free, online version of *[Applied Machine Learning Using mlr3 in R](https://mlr3book.mlr-org.com)* using [quarto](https://quarto.org).
You can buy a print copy of the book [here](https://www.routledge.com/Applied-Machine-Learning-Using-mlr3-in-R/Bischl-Sonabend-Kotthoff-Lang/p/book/9781032507545) - all profits from the book will go to the mlr organisation to support future maintenance and development of the mlr universe.
## Read the book
You can read the rendered version of the book in either:
- [HTML](https://mlr3book.mlr-org.com); or
- [PDF](https://mlr3book.mlr-org.com/Applied-Machine-Learning-Using-mlr3-in-R.pdf).
## Render the book
To render the book yourself, follow these steps:
1. Clone this repository (https://github.com/mlr-org/mlr3book.git)
2. Install Quarto >=1.3.283 if needed
3. Run `make serve` to render the book to HTML and preview on a local server or `make pdf` to render to PDF (other options are available and documented in the Makefile), note we use xelatex for rendering to PDF
## Contributing to the book
If you are making changes to the book please note the following:
* Our style guide is provided [here in the introduction](https://mlr3book.mlr-org.com/chapters/chapter1/introduction_and_overview.html#styleguide)
* Where possible, figures in the HTML book should be svgs and figures in the PDF should be pdf. These should be included with `knitr::include_graphics()` or ideally with [include_multi_graphics()](https://github.com/mlr-org/mlr3book/blob/main/book/common/_utils.qmd).
When (non-trivial) changes and corrections are made to chapters that are are included in the first published edition of this book, these changes should be documented in the *Errata* appendix.
When adding new chapters to the book not present in the published version, these should be marked as *Online Only* in their title.
For such newly added chapters that are in early stages and have not been rigorously edited and reviewed, these should be additionally marked as being a *Draft*.
* If you add a new package dependency to the book, please follow the following steps to update the lockfile:
* Start an R session in the `book/` directory
* Activate the project with `renv::activate()`
* Restore the project environment with `renv::restore()`
* Run `renv::install()` to install the new package
* Update the Lockfile with `renv::snapshot()`
* Commit `book/renv.lock` with your changes and create a pull request.