https://github.com/tidymodels/agua
Create and evaluate models using 'tidymodels' and 'h2o'
https://github.com/tidymodels/agua
Last synced: 9 months ago
JSON representation
Create and evaluate models using 'tidymodels' and 'h2o'
- Host: GitHub
- URL: https://github.com/tidymodels/agua
- Owner: tidymodels
- License: other
- Created: 2022-05-17T21:33:48.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-13T05:30:58.000Z (over 1 year ago)
- Last Synced: 2025-04-19T03:57:29.437Z (9 months ago)
- Language: R
- Homepage: https://agua.tidymodels.org
- Size: 7.34 MB
- Stars: 22
- Watchers: 8
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.Rmd
- Changelog: NEWS.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# agua 
[](https://app.codecov.io/gh/tidymodels/agua?branch=main)
[](https://github.com/tidymodels/agua/actions/workflows/R-CMD-check.yaml)
agua enables users to fit, optimize, and evaluate models via [H2O](https://h2o.ai/) using tidymodels syntax. Most users will not have to use aqua directly; the features can be accessed via the new parsnip computational engine `'h2o'`.
There are two main components in agua:
* New parsnip engine `'h2o'` for many models, see [Get started](https://agua.tidymodels.org/articles/agua.html) for a complete list.
* Infrastructure for the tune package.
When fitting a parsnip model, the data are passed to the h2o server directly. For tuning, the data are passed once and instructions are given to `h2o.grid()` to process them.
This work is based on @stevenpawley's [h2oparsnip](https://github.com/stevenpawley/h2oparsnip) package. Additional work was done by Qiushi Yan for his 2022 summer internship at RStudio.
## Installation
The CRAN version of the package can be installed via
```r
install.packages("agua")
```
You can also install the development version of agua using:
``` r
require(pak)
pak::pak("tidymodels/agua")
```
## Examples
The following code demonstrates how to create a single model on the h2o server and how to make predictions.
```r
library(tidymodels)
library(agua)
library(h2o)
tidymodels_prefer()
```
```r
# Start the h2o server before running models
h2o_start()
# Demonstrate fitting parsnip models:
# Specify the type of model and the h2o engine
spec <-
rand_forest(mtry = 3, trees = 1000) %>%
set_engine("h2o") %>%
set_mode("regression")
# Fit the model on the h2o server
set.seed(1)
mod <- fit(spec, mpg ~ ., data = mtcars)
mod
#> parsnip model object
#>
#> Model Details:
#> ==============
#>
#> H2ORegressionModel: drf
#> Model ID: DRF_model_R_1656520956148_1
#> Model Summary:
#> number_of_trees number_of_internal_trees model_size_in_bytes min_depth
#> 1 1000 1000 285914 4
#> max_depth mean_depth min_leaves max_leaves mean_leaves
#> 1 10 6.70600 10 27 18.04100
#>
#>
#> H2ORegressionMetrics: drf
#> ** Reported on training data. **
#> ** Metrics reported on Out-Of-Bag training samples **
#>
#> MSE: 4.354249
#> RMSE: 2.086684
#> MAE: 1.657823
#> RMSLE: 0.09848976
#> Mean Residual Deviance : 4.354249
# Predictions
predict(mod, head(mtcars))
#> # A tibble: 6 × 1
#> .pred
#>
#> 1 20.9
#> 2 20.8
#> 3 23.3
#> 4 20.4
#> 5 17.9
#> 6 18.7
# When done
h2o_end()
```
Before using the `'h2o'` engine, users need to run `agua::h2o_start()` or `h2o::h2o.init()` to start the h2o server, which will be storing data, models, and other values passed from the R session.
There are several package vignettes including:
- [Introduction to agua](https://agua.tidymodels.org/articles/agua.html)
- [Model tuning](https://agua.tidymodels.org/articles/tune.html)
- [Automatic machine learning](https://agua.tidymodels.org/articles/auto_ml.html)
- [Parallel processing with agua and h2o](https://agua.tidymodels.org/articles/parallel.html)
## Code of Conduct
Please note that the agua project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.