Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tidymodels/embed
Extra recipes for predictor embeddings
https://github.com/tidymodels/embed
Last synced: 3 days ago
JSON representation
Extra recipes for predictor embeddings
- Host: GitHub
- URL: https://github.com/tidymodels/embed
- Owner: tidymodels
- License: other
- Created: 2018-05-16T18:28:10.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-11-08T18:03:26.000Z (4 days ago)
- Last Synced: 2024-11-08T18:24:17.908Z (4 days ago)
- Language: R
- Homepage: https://embed.tidymodels.org
- Size: 14.1 MB
- Stars: 142
- Watchers: 12
- Forks: 18
- Open Issues: 15
-
Metadata Files:
- Readme: README.Rmd
- Changelog: NEWS.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
---
output: github_document
---
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-"
)
```
# embed 
[](https://github.com/tidymodels/embed/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/tidymodels/embed?branch=main)
[](https://CRAN.r-project.org/package=embed)
[](https://CRAN.r-project.org/package=embed)
## Introduction
`embed` has extra steps for the [`recipes`](https://recipes.tidymodels.org/) package for embedding predictors into one or more numeric columns. Almost all of the preprocessing methods are _supervised_.
These steps are available here in a separate package because the step dependencies, [`rstanarm`](https://CRAN.r-project.org/package=rstanarm), [`lme4`](https://CRAN.r-project.org/package=lme4), and [`keras`](https://CRAN.r-project.org/package=keras), are fairly heavy.
Some steps handle categorical predictors:
* `step_lencode_glm()`, `step_lencode_bayes()`, and `step_lencode_mixed()` estimate the effect of each of the factor levels on the outcome and these estimates are used as the new encoding. The estimates are estimated by a generalized linear model. This step can be executed without pooling (via `glm`) or with partial pooling (`stan_glm` or `lmer`). Currently implemented for numeric and two-class outcomes.
* `step_embed()` uses `keras::layer_embedding` to translate the original _C_ factor levels into a set of _D_ new variables (< _C_). The model fitting routine optimizes which factor levels are mapped to each of the new variables as well as the corresponding regression coefficients (i.e., neural network weights) that will be used as the new encodings.
* `step_woe()` creates new variables based on weight of evidence encodings.
* `step_feature_hash()` can create indicator variables using feature hashing.
For numeric predictors:
* `step_umap()` uses a nonlinear transformation similar to t-SNE but can be used to project the transformation on new data. Both supervised and unsupervised methods can be used.
* `step_discretize_xgb()` and `step_discretize_cart()` can make binned versions of numeric predictors using supervised tree-based models.
* `step_pca_sparse()` and `step_pca_sparse_bayes()` conduct feature extraction with sparsity of the component loadings.
Some references for these methods are:
* Francois C and Allaire JJ (2018) [_Deep Learning with R_](https://www.manning.com/books/deep-learning-with-r), Manning
* Guo, C and Berkhahn F (2016) "[Entity Embeddings of Categorical Variables](https://arxiv.org/abs/1604.06737)"
* Micci-Barreca D (2001) "[A preprocessing scheme for high-cardinality categorical attributes in classification and prediction problems](https://scholar.google.com/scholar?hl=en&as_sdt=0%2C5&q=A+preprocessing+scheme+for+high-cardinality+categorical+attributes+in+classification+and+prediction+problems&btnG=)," ACM SIGKDD Explorations Newsletter, 3(1), 27-32.
* Zumel N and Mount J (2017) "[`vtreat`: a `data.frame` Processor for Predictive Modeling](https://arxiv.org/abs/1611.09477)"
* McInnes L and Healy J (2018) [UMAP: Uniform Manifold Approximation and Projection for Dimension Reduction](https://arxiv.org/abs/1802.03426)
* Good, I. J. (1985), "[Weight of evidence: A brief survey](https://scholar.google.com/scholar?hl=en&as_sdt=0%2C5&q=Weight+of+evidence%3A+A+brief+survey&btnG=)", Bayesian Statistics, 2, pp.249-270.
## Getting Started
There are two articles that walk through how to use these embedding steps, using [generalized linear models](https://embed.tidymodels.org/articles/Applications/GLM.html) and [neural networks built via TensorFlow](https://embed.tidymodels.org/articles/Applications/Tensorflow.html).
## Installation
To install the package:
```r
install.packages("embed")
```
Note that to use some steps, you will also have to install other packages such as `rstanarm` and `lme4`. For all of the steps to work, you may want to use:
```r
install.packages(c("rpart", "xgboost", "rstanarm", "lme4"))
```
To get a bug fix or to use a feature from the development version, you can install the development version of this package from GitHub.
```r
# install.packages("pak")
pak::pak("tidymodels/embed")
```
## Contributing
This 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.
- For questions and discussions about tidymodels packages, modeling, and machine learning, please [post on RStudio Community](https://community.rstudio.com/new-topic?category_id=15&tags=tidymodels,question).
- If you think you have encountered a bug, please [submit an issue](https://github.com/tidymodels/embed/issues).
- Either way, learn how to create and share a [reprex](https://reprex.tidyverse.org/articles/articles/learn-reprex.html) (a minimal, reproducible example), to clearly communicate about your code.
- Check out further details on [contributing guidelines for tidymodels packages](https://www.tidymodels.org/contribute/) and [how to get help](https://www.tidymodels.org/help/).