{"id":13666079,"url":"https://github.com/mlr-org/mlr3book","last_synced_at":"2025-05-16T06:08:06.106Z","repository":{"id":37430934,"uuid":"172917699","full_name":"mlr-org/mlr3book","owner":"mlr-org","description":"Online version of Bischl, B., Sonabend, R., Kotthoff, L., \u0026 Lang, M. (Eds.). (2024). \"Applied Machine Learning Using mlr3 in R\". CRC Press.","archived":false,"fork":false,"pushed_at":"2025-05-13T08:28:47.000Z","size":844957,"stargazers_count":260,"open_issues_count":21,"forks_count":65,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-05-13T09:34:59.391Z","etag":null,"topics":["book","bookdown","machine-learning","mlr3","r"],"latest_commit_sha":null,"homepage":"https://mlr3book.mlr-org.com/","language":"TeX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mlr-org.png","metadata":{"funding":{"github":"mlr-org"},"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-02-27T13:09:05.000Z","updated_at":"2025-05-03T13:56:28.000Z","dependencies_parsed_at":"2024-05-30T17:25:51.702Z","dependency_job_id":"5a600a33-bff2-43f1-9916-6d4882d82ada","html_url":"https://github.com/mlr-org/mlr3book","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlr-org%2Fmlr3book","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlr-org%2Fmlr3book/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlr-org%2Fmlr3book/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlr-org%2Fmlr3book/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mlr-org","download_url":"https://codeload.github.com/mlr-org/mlr3book/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254478193,"owners_count":22077676,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["book","bookdown","machine-learning","mlr3","r"],"created_at":"2024-08-02T06:00:57.514Z","updated_at":"2025-05-16T06:08:01.094Z","avatar_url":"https://github.com/mlr-org.png","language":"TeX","funding_links":["https://github.com/sponsors/mlr-org"],"categories":["TeX"],"sub_categories":[],"readme":"# mlr3book\n\n[![mlr3book](https://github.com/mlr-org/mlr3book/actions/workflows/book-weekly.yml/badge.svg)](https://github.com/mlr-org/mlr3book/actions/workflows/book-weekly.yml)\n[![StackOverflow](https://img.shields.io/badge/stackoverflow-mlr3-orange.svg)](https://stackoverflow.com/questions/tagged/mlr3)\n[![Mattermost](https://img.shields.io/badge/chat-mattermost-orange.svg)](https://lmmisld-lmu-stats-slds.srv.mwn.de/mlr_invite/)\n\nRepository to build the free, online version of *[Applied Machine Learning Using mlr3 in R](https://mlr3book.mlr-org.com)* using [quarto](https://quarto.org).\nYou 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.\n\n\n## Read the book\n\nYou can read the rendered version of the book in either:\n\n- [HTML](https://mlr3book.mlr-org.com); or\n\n- [PDF](https://mlr3book.mlr-org.com/Applied-Machine-Learning-Using-mlr3-in-R.pdf).\n\n## Render the book\n\nTo render the book yourself, follow these steps:\n\n1. Clone this repository (https://github.com/mlr-org/mlr3book.git) and navigate to the `mlr3book` directory.\n2. Pull the docker image `docker pull mlrorgdocker/mlr3-book`.\n3. Preview the book with\n\n```bash\ndocker run -v $(pwd):/book \\\n --rm \\\n -p 8888:8888 \\\n mlrorgdocker/mlr3-book quarto preview book/book --port 8888 --host 0.0.0.0 --no-browser\n```\n\nThis command mounts your current directory into the docker container, allowing quarto to render the book and serve it on port 8888.\nAccess the preview at `http://0.0.0.0:8888`.\n\nMake your changes locally and preview them with the above command.\nOnce you are happy with your changes, open a pull request.\nThe pull request will include a preview of your changes\n\nIf your changes require new packages, install them in the docker image using the `remotes` package.\n\n```r\nremotes::install_github(\"mlr-org/mlr3extralearners\")\nremotes::install_cran(\"qgam\")\n```\n\nYou can add these command temporary at the beginning of the new chapter.\nOnce the pull request is accepted, add the new packages to the mlr3-book dockerfile at [https://github.com/mlr-org/mlr3docker](mlr-org/mlr3docker) and remove the installation with `remotes`.\n\n## Contributing to the book\n\nIf you are making changes to the book please note the following:\n\n* Our style guide is provided [here in the introduction](https://mlr3book.mlr-org.com/chapters/chapter1/introduction_and_overview.html#styleguide)\n* 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).\n\nWhen (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.\nWhen adding new chapters to the book not present in the published version, these should be marked as *Online Only* in their title.\nFor 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*.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmlr-org%2Fmlr3book","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmlr-org%2Fmlr3book","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmlr-org%2Fmlr3book/lists"}