Generate documentation for a classifier class

Function for generating the documentation of a model.

Usage

build_documentation_for_model(
  model_name,
  cls_type = NULL,
  core_type = NULL,
  input_type = "text_embeddings"
)

Arguments

model_name

string Name of the model.

cls_type

string Type of classification

core_type

string Name of the core type.

input_type

bool Name of the input type necessary for training and predicting.

Value

Returns a string containing the description written in rmarkdown.

Note

Function is designed to be used with roxygen2 in the regular documentation.

See also

Other Utils Documentation: build_layer_stack_documentation_for_vignette(), get_desc_for_core_model_architecture(), get_dict_cls_type(), get_dict_core_models(), get_dict_input_types(), get_layer_dict(), get_layer_documentation(), get_parameter_documentation()