View source: R/sequence_onehot.R
| step_sequence_onehot | R Documentation |
step_sequence_onehot() creates a specification of a recipe step that will
take a string and do one hot encoding for each character by position.
step_sequence_onehot(
recipe,
...,
role = "predictor",
trained = FALSE,
columns = NULL,
sequence_length = 100,
padding = "pre",
truncating = "pre",
vocabulary = NULL,
prefix = "seq1hot",
keep_original_cols = FALSE,
skip = FALSE,
id = rand_id("sequence_onehot")
)
recipe |
A |
... |
One or more selector functions to choose which variables are
affected by the step. See |
role |
For model terms created by this step, what analysis role should they be assigned? By default, the new columns created by this step from the original variables will be used as predictors in a model. |
trained |
A logical to indicate if the quantities for preprocessing have been estimated. |
columns |
A character vector of the selected variable names. This is
|
sequence_length |
A whole number, the number of characters to keep before
discarding. Defaults to |
padding |
A single string, either |
truncating |
A single string, either |
vocabulary |
A character vector of the characters to be mapped to
integers. Characters not in the vocabulary will be encoded as 0. If
|
prefix |
A character string that will be the prefix to the resulting new variables. See notes below. |
keep_original_cols |
A logical to keep the original variables in the
output. Defaults to |
skip |
A logical. Should the step be skipped when the recipe is baked
by |
id |
A character string that is unique to this step to identify it. |
The string will be capped by the sequence_length argument, strings shorter then sequence_length will be padded with empty characters. The encoding will assign an integer to each character in the vocabulary, and will encode accordingly. Characters not in the vocabulary will be encoded as 0.
The new columns will have names that begin with prefix, then the name of
the variable, then the position in the sequence, all separated by _. For
example, with the default prefix = "seq1hot", a variable named text, and
sequence_length = 3, the columns will be named seq1hot_text_1,
seq1hot_text_2, and seq1hot_text_3.
An updated version of recipe with the new step added
to the sequence of existing steps (if any).
When you tidy() this step, a tibble is returned with
columns terms, vocabulary, token, and id:
character, the selectors or variables selected
integer, index
character, text corresponding to the index
character, id of this step
The underlying operation does not allow for case weights.
https://papers.nips.cc/paper/5782-character-level-convolutional-networks-for-text-classification.pdf
Other Steps for Numeric Variables From Characters:
step_dummy_hash(),
step_sentence_embeddings(),
step_textfeature()
library(recipes)
library(modeldata)
data(tate_text)
tate_rec <- recipe(~medium, data = tate_text) |>
step_tokenize(medium) |>
step_tokenfilter(medium) |>
step_sequence_onehot(medium)
tate_obj <- tate_rec |>
prep()
bake(tate_obj, new_data = NULL)
tidy(tate_rec, number = 3)
tidy(tate_obj, number = 3)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.