set_model_mode: Register Mode for Model

In modelenv: Provide Tools to Register Models for Use in 'tidymodels'

Register Mode for Model

Description

This function is used to register a mode for a model.

Usage

set_model_mode(model, mode)

Arguments

model	A single character string for the model type (e.g. "k_means", etc).
mode	A single character string for the model mode (e.g. "partition").

Details

This function can be called multiple times without error. This becomes valuable when multiple packages adds the same mode to a model. Having both packages use set_model_mode() avoids having one package depend on the other.

Value

NULL invisibly

Examples

set_new_model("shallow_learning_model")

get_from_env("shallow_learning_model_modes")

set_model_mode("shallow_learning_model", "partition")

get_from_env("shallow_learning_model_modes")

modelenv documentation built on March 31, 2023, 10:31 p.m.