Skip to contents

Dictionary of core models

Source: R/def_DocumentationDesc.R
get_dict_core_models.Rd

Function for receiving a list containing a description of all core models user of the package can apply.

Usage

get_dict_core_models(model)

Arguments

model

string Name of the model that should be returned. If model="all" all models are returned as a list.

Value

Returns a list with the following entries:

  • title: string Name of the model.

  • desc: stringDescription of the model written in rmarkdown.

  • img: string Name of the image used to illustrate the model. File extension must be '.png'.

See also

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