aiq.utils.metadata_utils

Functions

generate_config_type_docs(→ str)

Generates a docstring from configuration object to facilitate discovery.

Module Contents

generate_config_type_docs(

config_type: aiq.data_models.common.TypedBaseModelT,

) → str

Generates a docstring from configuration object to facilitate discovery.

Args:

config_type (TypedBaseModelT): A component configuration object.

Returns:

str: An enriched docstring, including model attributes and default values.