kiara.metadata.module_models

KiaraModuleConfigMetadata pydantic-model

config_values: Dict[str, kiara.metadata.ValueTypeAndDescription] pydantic-field required

The available configuration values.

python_class: PythonClassMetadata pydantic-field required

The Python class for this configuration.

KiaraModuleInstanceMetadata pydantic-model

config: Dict[str, Any] pydantic-field required

Configuration that was used to create this module instance.

inputs_schema: Dict[str, kiara.data.values.ValueSchema] pydantic-field required

The schema for the module inputs.

outputs_schema: Dict[str, kiara.data.values.ValueSchema] pydantic-field required

The schema for the module outputs.

type_metadata: KiaraModuleTypeMetadata pydantic-field required

Metadata for the module type of this instance.

KiaraModuleTypeMetadata pydantic-model

config: KiaraModuleConfigMetadata pydantic-field required

Details on how this module type can be configured.

context: ContextMetadataModel pydantic-field required

Generic properties of this module (description, tags, labels, references, ...).

documentation: DocumentationMetadataModel pydantic-field required

Documentation for the module.

is_pipeline: bool pydantic-field required

Whether the module type is a pipeline, or a core module.

origin: OriginMetadataModel pydantic-field required

Information about authorship for the module type.

pipeline_config: PipelineConfig pydantic-field

If this module is a pipeline, this field contains the pipeline configuration.

process_src: str pydantic-field required

The source code of the process method of the module.

python_class: PythonClassMetadata pydantic-field required

Information about the Python class for this module type.

type_id: str pydantic-field required

The full type id.

type_name: str pydantic-field required

The registered name for this module type.