get_layer_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_layer_documentation(
  layer_name,
  title_format = "bold",
  subtitle_format = "italic",
  inc_img = FALSE,
  inc_params = FALSE,
  inc_references = FALSE
)

Arguments

layer_name	string Name of the layer.
title_format	string Kind of format of the title.
subtitle_format	string Kind of format for all sub-titles.
inc_img	bool Include a visualization of the layer.
inc_params	bool Include a description of every parameter of the layer.
inc_references	bool Include a list of literature references for the layer.

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_parameter_documentation()

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