get_parameter_documentation: Generate layer documentation

In aifeducation: Artificial Intelligence for Education

Generate layer documentation

Description

Function for generating the documentation of a specific layer.

Usage

get_parameter_documentation(
  param_name,
  param_dict,
  as_list = TRUE,
  inc_param_name = TRUE
)

Arguments

param_name	string Name of the parameter.
param_dict	list storing the parameter description.
as_list	bool If TRUE returns the element as part of a list.
inc_param_name	bool If TRUE the documentation includes the name of the parameter.

Value

Returns a string containing the description written in rmarkdown.

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_core_models(), get_dict_input_types(), get_layer_dict(), get_layer_documentation()

aifeducation documentation built on Nov. 19, 2025, 5:08 p.m.