Skip to content

Register Models

These functions are used together to register all the different types of information that is needed for them to be used in their respective tidymodels packages.

set_new_model()
Register New Model
set_model_mode()
Register Mode for Model
set_model_engine()
Register Engine for Model
set_dependency() get_dependency()
Register Dependency for Model
set_model_arg() get_model_arg()
Register Argument for Model
set_fit() get_fit()
Register Fit method for Model
set_encoding() get_encoding()
Register Encoding Options for Model
set_pred() get_pred_type()
Register Prediction Method for Model

Developer Functions

This set of functions can be useful inside modeling infrastructure to perform checking that the models, modes, and engines align.

stop_incompatible_mode()
Error handling for incompatible modes
check_spec_mode_engine_val()
Error handling for unknown mode
new_unsupervised_spec()
Give object unsupervised specification class
is_unsupervised_spec()
Determine object is has class unsupervised_spec
new_unsupervised_fit()
Give object unsupervised fit class
is_unsupervised_fit()
Determine object is has class unsupervised_fit

Model Environment

modelenv provides an environment which is used to store the registered models. These functions is how to access the underlying environment.

get_model_env() get_from_env() set_env_val()
Working with the modelenv model environment