operations

deserialize.bytes.as.python_object

type_name	deserialize.bytes.as.python_object	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type load.bytes The module type. module_config constants defaults value_type bytes target_profile python_object serialization_profile raw The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id deserialize.bytes.as.python_object The (unique) id of this operation. operation_details operation_id deserialize.bytes.as.python_object The id of the operation. is_internal_operation True Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema bytes type bytes The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value object. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. deserialization_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Serialization-format specific configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema python_object type python_object The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The deserialized python object instance. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. value_type bytes value_input_field bytes object_output_field python_object The (output) field name containing the deserialized python class. serialization_profile raw The name for the serialization profile used on the source value. target_profile python_object The target profile name. The operation specific details of this operation. doc description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name LoadBytesModule The name of the Python class. python_module_name kiara.modules.included_core_modules.serialization The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.serialization.LoadBytesModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. value_type bytes The value type of the actual (unserialized) value. target_profile python_object The profile name of the de-serialization result data. serialization_profile raw The name of the serialization profile used to serialize the source value. The module config. inputs_schema bytes type bytes The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value object. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. deserialization_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Serialization-format specific configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema python_object type python_object The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The deserialized python object instance. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	deserialize	The operation types this operation belongs to.
input_fields	bytes field_name bytes The field name. field_schema type bytes The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value object. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name bytes The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name BytesType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.BytesType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set). deserialization_config field_name deserialization_config The field name. field_schema type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Serialization-format specific configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name any The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name AnyType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.AnyType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	python_object field_name python_object The field name. field_schema type python_object The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The deserialized python object instance. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name internal The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name PythonObjectType The name of the Python class. python_module_name kiara.data_types.included_core_types.serialization The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.serialization.PythonObjectType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

deserialize.file.as.python_object

type_name	deserialize.file.as.python_object	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type deserialize.file The module type. module_config constants defaults value_type file target_profile python_object serialization_profile copy The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id deserialize.file.as.python_object The (unique) id of this operation. operation_details operation_id deserialize.file.as.python_object The id of the operation. is_internal_operation True Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema file type file The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value object. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. deserialization_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Serialization-format specific configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema python_object type python_object The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The deserialized python object instance. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. value_type file value_input_field file object_output_field python_object The (output) field name containing the deserialized python class. serialization_profile copy The name for the serialization profile used on the source value. target_profile python_object The target profile name. The operation specific details of this operation. doc description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name DeserializeFileModule The name of the Python class. python_module_name kiara.modules.included_core_modules.filesystem The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.filesystem.DeserializeFileModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. value_type file The value type of the actual (unserialized) value. target_profile python_object The profile name of the de-serialization result data. serialization_profile copy The name of the serialization profile used to serialize the source value. The module config. inputs_schema file type file The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value object. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. deserialization_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Serialization-format specific configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema python_object type python_object The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The deserialized python object instance. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	deserialize	The operation types this operation belongs to.
input_fields	file field_name file The field name. field_schema type file The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value object. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name file The registered name of this data type. data_type_config content_type None The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name FileValueType The name of the Python class. python_module_name kiara.data_types.included_core_types.filesystem The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.filesystem.FileValueType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set). deserialization_config field_name deserialization_config The field name. field_schema type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Serialization-format specific configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name any The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name AnyType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.AnyType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	python_object field_name python_object The field name. field_schema type python_object The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The deserialized python object instance. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name internal The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name PythonObjectType The name of the Python class. python_module_name kiara.data_types.included_core_types.serialization The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.serialization.PythonObjectType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

deserialize.file_bundle.as.python_object

type_name	deserialize.file_bundle.as.python_object	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type deserialize.file_bundle The module type. module_config constants defaults value_type file_bundle target_profile python_object serialization_profile copy The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id deserialize.file_bundle.as.python_object The (unique) id of this operation. operation_details operation_id deserialize.file_bundle.as.python_object The id of the operation. is_internal_operation True Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema file_bundle type file_bundle The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value object. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. deserialization_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Serialization-format specific configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema python_object type python_object The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The deserialized python object instance. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. value_type file_bundle value_input_field file_bundle object_output_field python_object The (output) field name containing the deserialized python class. serialization_profile copy The name for the serialization profile used on the source value. target_profile python_object The target profile name. The operation specific details of this operation. doc description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name DeserializeFileBundleModule The name of the Python class. python_module_name kiara.modules.included_core_modules.filesystem The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.filesystem.DeserializeFileBundleModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. value_type file_bundle The value type of the actual (unserialized) value. target_profile python_object The profile name of the de-serialization result data. serialization_profile copy The name of the serialization profile used to serialize the source value. The module config. inputs_schema file_bundle type file_bundle The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value object. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. deserialization_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Serialization-format specific configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema python_object type python_object The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The deserialized python object instance. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	deserialize	The operation types this operation belongs to.
input_fields	file_bundle field_name file_bundle The field name. field_schema type file_bundle The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value object. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name file_bundle The registered name of this data type. data_type_config content_type None The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name FileBundleValueType The name of the Python class. python_module_name kiara.data_types.included_core_types.filesystem The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.filesystem.FileBundleValueType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set). deserialization_config field_name deserialization_config The field name. field_schema type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Serialization-format specific configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name any The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name AnyType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.AnyType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	python_object field_name python_object The field name. field_schema type python_object The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The deserialized python object instance. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name internal The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name PythonObjectType The name of the Python class. python_module_name kiara.data_types.included_core_types.serialization The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.serialization.PythonObjectType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

deserialize.from_json

type_name	deserialize.from_json	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type deserialize.from_json The module type. module_config constants defaults result_path data The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id deserialize.from_json The (unique) id of this operation. operation_details operation_id deserialize.from_json The id of the operation. is_internal_operation True Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema value type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value object to deserialize the data for. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema python_object type python_object The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The deserialized python object. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. The operation specific details of this operation. doc description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name DeserializeFromJsonModule The name of the Python class. python_module_name kiara.modules.included_core_modules.serialization The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.serialization.DeserializeFromJsonModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. result_path data The path of the result dictionary to return. The module config. inputs_schema value type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value object to deserialize the data for. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema python_object type python_object The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The deserialized python object. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	custom_module	The operation types this operation belongs to.
input_fields	value field_name value The field name. field_schema type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value object to deserialize the data for. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name any The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name AnyType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.AnyType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	python_object field_name python_object The field name. field_schema type python_object The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The deserialized python object. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name internal The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name PythonObjectType The name of the Python class. python_module_name kiara.data_types.included_core_types.serialization The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.serialization.PythonObjectType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

deserialize.internal_model.as.python_object

type_name	deserialize.internal_model.as.python_object	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type load.internal_model The module type. module_config constants defaults value_type internal_model target_profile python_object serialization_profile json The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id deserialize.internal_model.as.python_object The (unique) id of this operation. operation_details operation_id deserialize.internal_model.as.python_object The id of the operation. is_internal_operation True Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema internal_model type internal_model The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value object. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. deserialization_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Serialization-format specific configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema python_object type python_object The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The deserialized python object instance. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. value_type internal_model value_input_field internal_model object_output_field python_object The (output) field name containing the deserialized python class. serialization_profile json The name for the serialization profile used on the source value. target_profile python_object The target profile name. The operation specific details of this operation. doc description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name LoadInternalModel The name of the Python class. python_module_name kiara.modules.included_core_modules.serialization The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.serialization.LoadInternalModel The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. value_type internal_model The value type of the actual (unserialized) value. target_profile python_object The profile name of the de-serialization result data. serialization_profile json The name of the serialization profile used to serialize the source value. The module config. inputs_schema internal_model type internal_model The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value object. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. deserialization_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Serialization-format specific configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema python_object type python_object The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The deserialized python object instance. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	deserialize	The operation types this operation belongs to.
input_fields	internal_model field_name internal_model The field name. field_schema type internal_model The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value object. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name internal_model The registered name of this data type. data_type_config kiara_model_id None The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name InternalModelValueType The name of the Python class. python_module_name kiara.data_types.included_core_types.internal The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.internal.InternalModelValueType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set). deserialization_config field_name deserialization_config The field name. field_schema type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Serialization-format specific configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name any The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name AnyType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.AnyType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	python_object field_name python_object The field name. field_schema type python_object The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The deserialized python object instance. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name internal The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name PythonObjectType The name of the Python class. python_module_name kiara.data_types.included_core_types.serialization The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.serialization.PythonObjectType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

deserialize.string.as.python_object

type_name	deserialize.string.as.python_object	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type load.string The module type. module_config constants defaults value_type string target_profile python_object serialization_profile raw The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id deserialize.string.as.python_object The (unique) id of this operation. operation_details operation_id deserialize.string.as.python_object The id of the operation. is_internal_operation True Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema string type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value object. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. deserialization_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Serialization-format specific configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema python_object type python_object The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The deserialized python object instance. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. value_type string value_input_field string object_output_field python_object The (output) field name containing the deserialized python class. serialization_profile raw The name for the serialization profile used on the source value. target_profile python_object The target profile name. The operation specific details of this operation. doc description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name LoadStringModule The name of the Python class. python_module_name kiara.modules.included_core_modules.serialization The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.serialization.LoadStringModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. value_type string The value type of the actual (unserialized) value. target_profile python_object The profile name of the de-serialization result data. serialization_profile raw The name of the serialization profile used to serialize the source value. The module config. inputs_schema string type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value object. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. deserialization_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Serialization-format specific configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema python_object type python_object The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The deserialized python object instance. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	deserialize	The operation types this operation belongs to.
input_fields	string field_name string The field name. field_schema type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value object. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name string The registered name of this data type. data_type_config allowed_strings None The (optional) configuration for this data type. characteristics is_scalar True Whether the data desribed by this data type behaves like a skalar. is_json_serializable True Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name StringType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.StringType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set). deserialization_config field_name deserialization_config The field name. field_schema type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Serialization-format specific configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name any The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name AnyType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.AnyType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	python_object field_name python_object The field name. field_schema type python_object The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The deserialized python object instance. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name internal The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name PythonObjectType The name of the Python class. python_module_name kiara.data_types.included_core_types.serialization The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.serialization.PythonObjectType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

deserialize.value

type_name	deserialize.value	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type unpickle.value The module type. module_config constants defaults value_type any target_profile python_object serialization_profile pickle The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id deserialize.value The (unique) id of this operation. operation_details operation_id deserialize.value The id of the operation. is_internal_operation True Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema any type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value object. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. deserialization_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Serialization-format specific configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema python_object type python_object The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The deserialized python object instance. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. value_type any value_input_field any object_output_field python_object The (output) field name containing the deserialized python class. serialization_profile pickle The name for the serialization profile used on the source value. target_profile python_object The target profile name. The operation specific details of this operation. doc description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name UnpickleModule The name of the Python class. python_module_name kiara.modules.included_core_modules.serialization The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.serialization.UnpickleModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. value_type any The value type of the actual (unserialized) value. target_profile python_object The profile name of the de-serialization result data. serialization_profile pickle The name of the serialization profile used to serialize the source value. The module config. inputs_schema any type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value object. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. deserialization_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Serialization-format specific configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema python_object type python_object The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The deserialized python object instance. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	deserialize	The operation types this operation belongs to.
input_fields	any field_name any The field name. field_schema type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value object. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name any The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name AnyType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.AnyType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set). deserialization_config field_name deserialization_config The field name. field_schema type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Serialization-format specific configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name any The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name AnyType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.AnyType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	python_object field_name python_object The field name. field_schema type python_object The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The deserialized python object instance. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name internal The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name PythonObjectType The name of the Python class. python_module_name kiara.data_types.included_core_types.serialization The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.serialization.PythonObjectType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

export.file.as.file

type_name	export.file.as.file	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type export.file The module type. module_config constants defaults target_profile file source_type file The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id export.file.as.file The (unique) id of this operation. operation_details operation_id export.file.as.file The id of the operation. is_internal_operation False Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema file type file The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description A value of type 'file'. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. base_path type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The directory to export the file(s) to. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. name type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The (base) name of the exported file(s). Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. export_metadata type boolean The type of the value. type_config Configuration for the type, in case it's complex. default False A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Whether to also export the value metadata. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema export_details type dict The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Details about the exported files/folders. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. source_type file The type of the value to be created. target_profile file The result profile type. optional_args base_path type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The directory to export the file(s) to. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. name type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The (base) name of the exported file(s). Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. export_metadata type boolean The type of the value. type_config Configuration for the type, in case it's complex. default False A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Whether to also export the value metadata. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. Optional arguments. The operation specific details of this operation. doc description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name ExportFileModule The name of the Python class. python_module_name kiara.modules.included_core_modules.filesystem The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.filesystem.ExportFileModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. target_profile file The name of the target profile. Used to distinguish different target formats for the same data type. source_type file The type of the source data that is going to be exported. The module config. inputs_schema file type file The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description A value of type 'file'. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. base_path type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The directory to export the file(s) to. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. name type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The (base) name of the exported file(s). Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. export_metadata type boolean The type of the value. type_config Configuration for the type, in case it's complex. default False A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Whether to also export the value metadata. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema export_details type dict The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Details about the exported files/folders. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	export_as	The operation types this operation belongs to.
input_fields	file field_name file The field name. field_schema type file The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description A value of type 'file'. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name file The registered name of this data type. data_type_config content_type None The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name FileValueType The name of the Python class. python_module_name kiara.data_types.included_core_types.filesystem The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.filesystem.FileValueType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set). base_path field_name base_path The field name. field_schema type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The directory to export the file(s) to. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name string The registered name of this data type. data_type_config allowed_strings None The (optional) configuration for this data type. characteristics is_scalar True Whether the data desribed by this data type behaves like a skalar. is_json_serializable True Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name StringType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.StringType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set). name field_name name The field name. field_schema type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The (base) name of the exported file(s). Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name string The registered name of this data type. data_type_config allowed_strings None The (optional) configuration for this data type. characteristics is_scalar True Whether the data desribed by this data type behaves like a skalar. is_json_serializable True Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name StringType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.StringType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set). export_metadata field_name export_metadata The field name. field_schema type boolean The type of the value. type_config Configuration for the type, in case it's complex. default False A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Whether to also export the value metadata. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name boolean The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar True Whether the data desribed by this data type behaves like a skalar. is_json_serializable True Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name BooleanType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.BooleanType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	export_details field_name export_details The field name. field_schema type dict The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Details about the exported files/folders. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name dict The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable True Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name DictValueType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.DictValueType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

extract.file.metadata.from.file

type_name	extract.file.metadata.from.file	The registered name for this item type.
documentation	description Extract 'file' metadata for value type 'file'. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type value.extract_metadata The module type. module_config constants defaults data_type file kiara_model_id metadata.file The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id extract.file.metadata.from.file The (unique) id of this operation. operation_details operation_id extract.file.metadata.from.file The id of the operation. is_internal_operation True Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema value type file The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description A value of type 'file' Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema value_metadata type internal_model The type of the value. type_config kiara_model_id metadata.file Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The metadata for the provided value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. data_type file The data type this metadata operation can be used with. metadata_key file The metadata key. input_field_name value The input field name. result_field_name value_metadata The result field name. The operation specific details of this operation. doc description Extract 'file' metadata for value type 'file'. Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name ExtractMetadataModule The name of the Python class. python_module_name kiara.modules.included_core_modules.metadata The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.metadata.ExtractMetadataModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. data_type file The data type this module will be used for. kiara_model_id metadata.file The id of the kiara (metadata) model. The module config. inputs_schema value type file The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description A value of type 'file' Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema value_metadata type internal_model The type of the value. type_config kiara_model_id metadata.file Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The metadata for the provided value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	extract_metadata	The operation types this operation belongs to.
input_fields	value field_name value The field name. field_schema type file The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description A value of type 'file' Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name file The registered name of this data type. data_type_config content_type None The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name FileValueType The name of the Python class. python_module_name kiara.data_types.included_core_types.filesystem The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.filesystem.FileValueType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	value_metadata field_name value_metadata The field name. field_schema type internal_model The type of the value. type_config kiara_model_id metadata.file Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The metadata for the provided value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name internal_model The registered name of this data type. data_type_config kiara_model_id metadata.file The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name InternalModelValueType The name of the Python class. python_module_name kiara.data_types.included_core_types.internal The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.internal.InternalModelValueType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

extract.file_bundle.metadata.from.file_bundle

type_name	extract.file_bundle.metadata.from.file_bundle	The registered name for this item type.
documentation	description Extract 'file_bundle' metadata for value type 'file_bundle'. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type value.extract_metadata The module type. module_config constants defaults data_type file_bundle kiara_model_id metadata.file_bundle The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id extract.file_bundle.metadata.from.file_bundle The (unique) id of this operation. operation_details operation_id extract.file_bundle.metadata.from.file_bundle The id of the operation. is_internal_operation True Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema value type file_bundle The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description A value of type 'file_bundle' Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema value_metadata type internal_model The type of the value. type_config kiara_model_id metadata.file_bundle Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The metadata for the provided value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. data_type file_bundle The data type this metadata operation can be used with. metadata_key file_bundle The metadata key. input_field_name value The input field name. result_field_name value_metadata The result field name. The operation specific details of this operation. doc description Extract 'file_bundle' metadata for value type 'file_bundle'. Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name ExtractMetadataModule The name of the Python class. python_module_name kiara.modules.included_core_modules.metadata The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.metadata.ExtractMetadataModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. data_type file_bundle The data type this module will be used for. kiara_model_id metadata.file_bundle The id of the kiara (metadata) model. The module config. inputs_schema value type file_bundle The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description A value of type 'file_bundle' Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema value_metadata type internal_model The type of the value. type_config kiara_model_id metadata.file_bundle Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The metadata for the provided value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	extract_metadata	The operation types this operation belongs to.
input_fields	value field_name value The field name. field_schema type file_bundle The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description A value of type 'file_bundle' Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name file_bundle The registered name of this data type. data_type_config content_type None The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name FileBundleValueType The name of the Python class. python_module_name kiara.data_types.included_core_types.filesystem The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.filesystem.FileBundleValueType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	value_metadata field_name value_metadata The field name. field_schema type internal_model The type of the value. type_config kiara_model_id metadata.file_bundle Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The metadata for the provided value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name internal_model The registered name of this data type. data_type_config kiara_model_id metadata.file_bundle The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name InternalModelValueType The name of the Python class. python_module_name kiara.data_types.included_core_types.internal The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.internal.InternalModelValueType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

extract.python_class.metadata

type_name	extract.python_class.metadata	The registered name for this item type.
documentation	description Extract 'python_class' metadata for value type 'any'. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type value.extract_metadata The module type. module_config constants defaults data_type any kiara_model_id metadata.python_class The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id extract.python_class.metadata The (unique) id of this operation. operation_details operation_id extract.python_class.metadata The id of the operation. is_internal_operation True Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema value type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description A value of type 'any' Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema value_metadata type internal_model The type of the value. type_config kiara_model_id metadata.python_class Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The metadata for the provided value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. data_type any The data type this metadata operation can be used with. metadata_key python_class The metadata key. input_field_name value The input field name. result_field_name value_metadata The result field name. The operation specific details of this operation. doc description Extract 'python_class' metadata for value type 'any'. Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name ExtractMetadataModule The name of the Python class. python_module_name kiara.modules.included_core_modules.metadata The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.metadata.ExtractMetadataModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. data_type any The data type this module will be used for. kiara_model_id metadata.python_class The id of the kiara (metadata) model. The module config. inputs_schema value type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description A value of type 'any' Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema value_metadata type internal_model The type of the value. type_config kiara_model_id metadata.python_class Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The metadata for the provided value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	extract_metadata	The operation types this operation belongs to.
input_fields	value field_name value The field name. field_schema type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description A value of type 'any' Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name any The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name AnyType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.AnyType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	value_metadata field_name value_metadata The field name. field_schema type internal_model The type of the value. type_config kiara_model_id metadata.python_class Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The metadata for the provided value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name internal_model The registered name of this data type. data_type_config kiara_model_id metadata.python_class The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name InternalModelValueType The name of the Python class. python_module_name kiara.data_types.included_core_types.internal The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.internal.InternalModelValueType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

file_bundle.pick.file

type_name	file_bundle.pick.file	The registered name for this item type.
documentation	description Pick a single file from a file_bundle value. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type file_bundle.pick.file The module type. module_config constants defaults The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id file_bundle.pick.file The (unique) id of this operation. operation_details operation_id file_bundle.pick.file The id of the operation. is_internal_operation False Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema file_bundle type file_bundle The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The file bundle. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. path type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The relative path of the file to pick. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema file type file The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The file. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. The operation specific details of this operation. doc description Pick a single file from a file_bundle value. Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name PickFileFromFileBundleModule The name of the Python class. python_module_name kiara.modules.included_core_modules.filesystem The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.filesystem.PickFileFromFileBundleModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. The module config. inputs_schema file_bundle type file_bundle The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The file bundle. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. path type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The relative path of the file to pick. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema file type file The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The file. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	custom_module	The operation types this operation belongs to.
input_fields	file_bundle field_name file_bundle The field name. field_schema type file_bundle The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The file bundle. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name file_bundle The registered name of this data type. data_type_config content_type None The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name FileBundleValueType The name of the Python class. python_module_name kiara.data_types.included_core_types.filesystem The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.filesystem.FileBundleValueType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set). path field_name path The field name. field_schema type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The relative path of the file to pick. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name string The registered name of this data type. data_type_config allowed_strings None The (optional) configuration for this data type. characteristics is_scalar True Whether the data desribed by this data type behaves like a skalar. is_json_serializable True Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name StringType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.StringType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	file field_name file The field name. field_schema type file The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The file. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name file The registered name of this data type. data_type_config content_type None The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name FileValueType The name of the Python class. python_module_name kiara.data_types.included_core_types.filesystem The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.filesystem.FileValueType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

file_bundle.pick.sub_folder

type_name	file_bundle.pick.sub_folder	The registered name for this item type.
documentation	description Pick a sub-folder from a file_bundle, resulting in a new file_bundle. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type file_bundle.pick.sub_folder The module type. module_config constants defaults The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id file_bundle.pick.sub_folder The (unique) id of this operation. operation_details operation_id file_bundle.pick.sub_folder The id of the operation. is_internal_operation False Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema file_bundle type file_bundle The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The file bundle. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. sub_path type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The relative path of the sub-folder to pick. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema file_bundle type file_bundle The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The picked (sub-)file_bundle. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. The operation specific details of this operation. doc description Pick a sub-folder from a file_bundle, resulting in a new file_bundle. Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name PickSubBundle The name of the Python class. python_module_name kiara.modules.included_core_modules.filesystem The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.filesystem.PickSubBundle The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. The module config. inputs_schema file_bundle type file_bundle The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The file bundle. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. sub_path type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The relative path of the sub-folder to pick. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema file_bundle type file_bundle The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The picked (sub-)file_bundle. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	custom_module	The operation types this operation belongs to.
input_fields	file_bundle field_name file_bundle The field name. field_schema type file_bundle The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The file bundle. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name file_bundle The registered name of this data type. data_type_config content_type None The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name FileBundleValueType The name of the Python class. python_module_name kiara.data_types.included_core_types.filesystem The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.filesystem.FileBundleValueType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set). sub_path field_name sub_path The field name. field_schema type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The relative path of the sub-folder to pick. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name string The registered name of this data type. data_type_config allowed_strings None The (optional) configuration for this data type. characteristics is_scalar True Whether the data desribed by this data type behaves like a skalar. is_json_serializable True Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name StringType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.StringType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	file_bundle field_name file_bundle The field name. field_schema type file_bundle The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The picked (sub-)file_bundle. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name file_bundle The registered name of this data type. data_type_config content_type None The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name FileBundleValueType The name of the Python class. python_module_name kiara.data_types.included_core_types.filesystem The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.filesystem.FileBundleValueType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

import.local.file

type_name	import.local.file	The registered name for this item type.
documentation	description Import a file from the local filesystem. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type import.local.file The module type. module_config constants defaults The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id import.local.file The (unique) id of this operation. operation_details operation_id import.local.file The id of the operation. is_internal_operation False Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema path type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The local path to the file. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema file type file The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The loaded files. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. The operation specific details of this operation. doc description Import a file from the local filesystem. Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name ImportLocalFileModule The name of the Python class. python_module_name kiara.modules.included_core_modules.filesystem The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.filesystem.ImportLocalFileModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. The module config. inputs_schema path type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The local path to the file. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema file type file The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The loaded files. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	custom_module	The operation types this operation belongs to.
input_fields	path field_name path The field name. field_schema type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The local path to the file. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name string The registered name of this data type. data_type_config allowed_strings None The (optional) configuration for this data type. characteristics is_scalar True Whether the data desribed by this data type behaves like a skalar. is_json_serializable True Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name StringType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.StringType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	file field_name file The field name. field_schema type file The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The loaded files. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name file The registered name of this data type. data_type_config content_type None The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name FileValueType The name of the Python class. python_module_name kiara.data_types.included_core_types.filesystem The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.filesystem.FileValueType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

import.local.file_bundle

type_name	import.local.file_bundle	The registered name for this item type.
documentation	description Import a folder (file_bundle) from the local filesystem. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type import.local.file_bundle The module type. module_config constants defaults include_file_types None exclude_file_types None The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id import.local.file_bundle The (unique) id of this operation. operation_details operation_id import.local.file_bundle The id of the operation. is_internal_operation False Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema path type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The local path of the folder to import. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema file_bundle type file_bundle The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The imported file bundle. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. The operation specific details of this operation. doc description Import a folder (file_bundle) from the local filesystem. Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name ImportLocalFileBundleModule The name of the Python class. python_module_name kiara.modules.included_core_modules.filesystem The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.filesystem.ImportLocalFileBundleModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. include_file_types None File types to include. exclude_file_types None File types to include. The module config. inputs_schema path type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The local path of the folder to import. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema file_bundle type file_bundle The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The imported file bundle. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	custom_module	The operation types this operation belongs to.
input_fields	path field_name path The field name. field_schema type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The local path of the folder to import. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name string The registered name of this data type. data_type_config allowed_strings None The (optional) configuration for this data type. characteristics is_scalar True Whether the data desribed by this data type behaves like a skalar. is_json_serializable True Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name StringType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.StringType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	file_bundle field_name file_bundle The field name. field_schema type file_bundle The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The imported file bundle. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name file_bundle The registered name of this data type. data_type_config content_type None The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name FileBundleValueType The name of the Python class. python_module_name kiara.data_types.included_core_types.filesystem The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.filesystem.FileBundleValueType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

pretty_print.as.string

type_name	pretty_print.as.string	The registered name for this item type.
documentation	description Pretty print a any value as a string. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type pretty_print.value The module type. module_config constants defaults source_type any target_type string The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id pretty_print.as.string The (unique) id of this operation. operation_details operation_id pretty_print.as.string The id of the operation. is_internal_operation True Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema value type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. render_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Value type dependent render configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema rendered_value type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. source_type any The type of the value to be rendered. target_type string The type of the render result. The operation specific details of this operation. doc description Pretty print a any value as a string. Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name ValueTypePrettyPrintModule The name of the Python class. python_module_name kiara.modules.included_core_modules.pretty_print The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.pretty_print.ValueTypePrettyPrintModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. source_type any The value type of the source value. target_type string The value type of the rendered value. The module config. inputs_schema value type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. render_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Value type dependent render configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema rendered_value type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	pretty_print	The operation types this operation belongs to.
input_fields	value field_name value The field name. field_schema type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name any The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name AnyType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.AnyType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set). render_config field_name render_config The field name. field_schema type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Value type dependent render configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name any The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name AnyType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.AnyType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	rendered_value field_name rendered_value The field name. field_schema type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name string The registered name of this data type. data_type_config allowed_strings None The (optional) configuration for this data type. characteristics is_scalar True Whether the data desribed by this data type behaves like a skalar. is_json_serializable True Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name StringType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.StringType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

pretty_print.as.terminal_renderable

type_name	pretty_print.as.terminal_renderable	The registered name for this item type.
documentation	description Pretty print a any value as a terminal_renderable. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type pretty_print.value The module type. module_config constants defaults source_type any target_type terminal_renderable The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id pretty_print.as.terminal_renderable The (unique) id of this operation. operation_details operation_id pretty_print.as.terminal_renderable The id of the operation. is_internal_operation True Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema value type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. render_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Value type dependent render configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema rendered_value type terminal_renderable The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. source_type any The type of the value to be rendered. target_type terminal_renderable The type of the render result. The operation specific details of this operation. doc description Pretty print a any value as a terminal_renderable. Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name ValueTypePrettyPrintModule The name of the Python class. python_module_name kiara.modules.included_core_modules.pretty_print The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.pretty_print.ValueTypePrettyPrintModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. source_type any The value type of the source value. target_type terminal_renderable The value type of the rendered value. The module config. inputs_schema value type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. render_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Value type dependent render configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema rendered_value type terminal_renderable The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	pretty_print	The operation types this operation belongs to.
input_fields	value field_name value The field name. field_schema type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name any The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name AnyType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.AnyType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set). render_config field_name render_config The field name. field_schema type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Value type dependent render configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name any The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name AnyType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.AnyType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	rendered_value field_name rendered_value The field name. field_schema type terminal_renderable The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name terminal_renderable The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name TerminalRenderable The name of the Python class. python_module_name kiara.data_types.included_core_types.internal The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.internal.TerminalRenderable The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

pretty_print.internal.as.string

type_name	pretty_print.internal.as.string	The registered name for this item type.
documentation	description Pretty print a internal value as a string. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type pretty_print.value The module type. module_config constants defaults source_type internal target_type string The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id pretty_print.internal.as.string The (unique) id of this operation. operation_details operation_id pretty_print.internal.as.string The id of the operation. is_internal_operation True Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema value type internal The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. render_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Value type dependent render configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema rendered_value type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. source_type internal The type of the value to be rendered. target_type string The type of the render result. The operation specific details of this operation. doc description Pretty print a internal value as a string. Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name ValueTypePrettyPrintModule The name of the Python class. python_module_name kiara.modules.included_core_modules.pretty_print The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.pretty_print.ValueTypePrettyPrintModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. source_type internal The value type of the source value. target_type string The value type of the rendered value. The module config. inputs_schema value type internal The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. render_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Value type dependent render configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema rendered_value type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	pretty_print	The operation types this operation belongs to.
input_fields	value field_name value The field name. field_schema type internal The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name internal The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name InternalType The name of the Python class. python_module_name kiara.data_types.included_core_types.internal The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.internal.InternalType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set). render_config field_name render_config The field name. field_schema type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Value type dependent render configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name any The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name AnyType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.AnyType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	rendered_value field_name rendered_value The field name. field_schema type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name string The registered name of this data type. data_type_config allowed_strings None The (optional) configuration for this data type. characteristics is_scalar True Whether the data desribed by this data type behaves like a skalar. is_json_serializable True Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name StringType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.StringType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

pretty_print.internal.as.terminal_renderable

type_name	pretty_print.internal.as.terminal_renderable	The registered name for this item type.
documentation	description Pretty print a internal value as a terminal_renderable. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type pretty_print.value The module type. module_config constants defaults source_type internal target_type terminal_renderable The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id pretty_print.internal.as.terminal_renderable The (unique) id of this operation. operation_details operation_id pretty_print.internal.as.terminal_renderable The id of the operation. is_internal_operation True Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema value type internal The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. render_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Value type dependent render configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema rendered_value type terminal_renderable The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. source_type internal The type of the value to be rendered. target_type terminal_renderable The type of the render result. The operation specific details of this operation. doc description Pretty print a internal value as a terminal_renderable. Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name ValueTypePrettyPrintModule The name of the Python class. python_module_name kiara.modules.included_core_modules.pretty_print The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.pretty_print.ValueTypePrettyPrintModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. source_type internal The value type of the source value. target_type terminal_renderable The value type of the rendered value. The module config. inputs_schema value type internal The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. render_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Value type dependent render configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema rendered_value type terminal_renderable The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	pretty_print	The operation types this operation belongs to.
input_fields	value field_name value The field name. field_schema type internal The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name internal The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name InternalType The name of the Python class. python_module_name kiara.data_types.included_core_types.internal The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.internal.InternalType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set). render_config field_name render_config The field name. field_schema type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Value type dependent render configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name any The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name AnyType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.AnyType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	rendered_value field_name rendered_value The field name. field_schema type terminal_renderable The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name terminal_renderable The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name TerminalRenderable The name of the Python class. python_module_name kiara.data_types.included_core_types.internal The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.internal.TerminalRenderable The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

pretty_print.none.as.string

type_name	pretty_print.none.as.string	The registered name for this item type.
documentation	description Pretty print a none value as a string. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type pretty_print.value The module type. module_config constants defaults source_type none target_type string The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id pretty_print.none.as.string The (unique) id of this operation. operation_details operation_id pretty_print.none.as.string The id of the operation. is_internal_operation True Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema value type none The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. render_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Value type dependent render configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema rendered_value type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. source_type none The type of the value to be rendered. target_type string The type of the render result. The operation specific details of this operation. doc description Pretty print a none value as a string. Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name ValueTypePrettyPrintModule The name of the Python class. python_module_name kiara.modules.included_core_modules.pretty_print The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.pretty_print.ValueTypePrettyPrintModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. source_type none The value type of the source value. target_type string The value type of the rendered value. The module config. inputs_schema value type none The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. render_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Value type dependent render configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema rendered_value type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	pretty_print	The operation types this operation belongs to.
input_fields	value field_name value The field name. field_schema type none The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name none The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name NoneType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.NoneType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set). render_config field_name render_config The field name. field_schema type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Value type dependent render configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name any The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name AnyType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.AnyType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	rendered_value field_name rendered_value The field name. field_schema type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name string The registered name of this data type. data_type_config allowed_strings None The (optional) configuration for this data type. characteristics is_scalar True Whether the data desribed by this data type behaves like a skalar. is_json_serializable True Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name StringType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.StringType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

pretty_print.none.as.terminal_renderable

type_name	pretty_print.none.as.terminal_renderable	The registered name for this item type.
documentation	description Pretty print a none value as a terminal_renderable. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type pretty_print.value The module type. module_config constants defaults source_type none target_type terminal_renderable The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id pretty_print.none.as.terminal_renderable The (unique) id of this operation. operation_details operation_id pretty_print.none.as.terminal_renderable The id of the operation. is_internal_operation True Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema value type none The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. render_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Value type dependent render configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema rendered_value type terminal_renderable The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. source_type none The type of the value to be rendered. target_type terminal_renderable The type of the render result. The operation specific details of this operation. doc description Pretty print a none value as a terminal_renderable. Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name ValueTypePrettyPrintModule The name of the Python class. python_module_name kiara.modules.included_core_modules.pretty_print The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.pretty_print.ValueTypePrettyPrintModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. source_type none The value type of the source value. target_type terminal_renderable The value type of the rendered value. The module config. inputs_schema value type none The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. render_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Value type dependent render configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema rendered_value type terminal_renderable The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	pretty_print	The operation types this operation belongs to.
input_fields	value field_name value The field name. field_schema type none The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name none The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name NoneType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.NoneType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set). render_config field_name render_config The field name. field_schema type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Value type dependent render configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name any The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name AnyType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.AnyType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	rendered_value field_name rendered_value The field name. field_schema type terminal_renderable The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name terminal_renderable The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name TerminalRenderable The name of the Python class. python_module_name kiara.data_types.included_core_types.internal The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.internal.TerminalRenderable The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

pretty_print.string.as.bytes

type_name	pretty_print.string.as.bytes	The registered name for this item type.
documentation	description Pretty print a string value as a bytes. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type pretty_print.value The module type. module_config constants defaults source_type string target_type bytes The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id pretty_print.string.as.bytes The (unique) id of this operation. operation_details operation_id pretty_print.string.as.bytes The id of the operation. is_internal_operation True Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema value type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. render_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Value type dependent render configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema rendered_value type bytes The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. source_type string The type of the value to be rendered. target_type bytes The type of the render result. The operation specific details of this operation. doc description Pretty print a string value as a bytes. Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name ValueTypePrettyPrintModule The name of the Python class. python_module_name kiara.modules.included_core_modules.pretty_print The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.pretty_print.ValueTypePrettyPrintModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. source_type string The value type of the source value. target_type bytes The value type of the rendered value. The module config. inputs_schema value type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. render_config type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Value type dependent render configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema rendered_value type bytes The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	pretty_print	The operation types this operation belongs to.
input_fields	value field_name value The field name. field_schema type string The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name string The registered name of this data type. data_type_config allowed_strings None The (optional) configuration for this data type. characteristics is_scalar True Whether the data desribed by this data type behaves like a skalar. is_json_serializable True Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name StringType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.StringType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set). render_config field_name render_config The field name. field_schema type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional True Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Value type dependent render configuration. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name any The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name AnyType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.AnyType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	rendered_value field_name rendered_value The field name. field_schema type bytes The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name bytes The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name BytesType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.BytesType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

render.as.string

type_name	render.as.string	The registered name for this item type.
documentation	description Render a 'any' value as a string. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type render.value The module type. module_config constants defaults source_type any target_type string The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id render.as.string The (unique) id of this operation. operation_details operation_id render.as.string The id of the operation. is_internal_operation True Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema value type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. render_config type dict The type of the value. type_config Configuration for the type, in case it's complex. default A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Instructions/config on how (or what) to render the provided value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema render_value_result type render_value_result The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value, incl. some metadata. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. source_data_type any The data type that will be rendered. target_data_type string The rendered data type. The operation specific details of this operation. doc description Render a 'any' value as a string. Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name ValueTypeRenderModule The name of the Python class. python_module_name kiara.modules.included_core_modules.render_value The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.render_value.ValueTypeRenderModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. source_type any The (kiara) data type to be rendered. target_type string The (kiara) data type of210 the rendered result. The module config. inputs_schema value type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. render_config type dict The type of the value. type_config Configuration for the type, in case it's complex. default A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Instructions/config on how (or what) to render the provided value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema render_value_result type render_value_result The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value, incl. some metadata. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	render_value	The operation types this operation belongs to.
input_fields	value field_name value The field name. field_schema type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name any The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name AnyType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.AnyType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set). render_config field_name render_config The field name. field_schema type dict The type of the value. type_config Configuration for the type, in case it's complex. default A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Instructions/config on how (or what) to render the provided value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name dict The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable True Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name DictValueType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.DictValueType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	render_value_result field_name render_value_result The field name. field_schema type render_value_result The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value, incl. some metadata. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name render_value_result The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name RenderValueResultDataType The name of the Python class. python_module_name kiara.data_types.included_core_types.internal.render_value The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.internal.render_value.RenderValueResultDataType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

render.as.terminal_renderable

type_name	render.as.terminal_renderable	The registered name for this item type.
documentation	description Render a 'any' value as a terminal_renderable. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type render.value The module type. module_config constants defaults source_type any target_type terminal_renderable The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id render.as.terminal_renderable The (unique) id of this operation. operation_details operation_id render.as.terminal_renderable The id of the operation. is_internal_operation True Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema value type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. render_config type dict The type of the value. type_config Configuration for the type, in case it's complex. default A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Instructions/config on how (or what) to render the provided value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema render_value_result type render_value_result The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value, incl. some metadata. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. source_data_type any The data type that will be rendered. target_data_type terminal_renderable The rendered data type. The operation specific details of this operation. doc description Render a 'any' value as a terminal_renderable. Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name ValueTypeRenderModule The name of the Python class. python_module_name kiara.modules.included_core_modules.render_value The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.render_value.ValueTypeRenderModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. source_type any The (kiara) data type to be rendered. target_type terminal_renderable The (kiara) data type of210 the rendered result. The module config. inputs_schema value type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. render_config type dict The type of the value. type_config Configuration for the type, in case it's complex. default A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Instructions/config on how (or what) to render the provided value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema render_value_result type render_value_result The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value, incl. some metadata. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	render_value	The operation types this operation belongs to.
input_fields	value field_name value The field name. field_schema type any The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name any The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name AnyType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.AnyType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set). render_config field_name render_config The field name. field_schema type dict The type of the value. type_config Configuration for the type, in case it's complex. default A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Instructions/config on how (or what) to render the provided value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name dict The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable True Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name DictValueType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.DictValueType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	render_value_result field_name render_value_result The field name. field_schema type render_value_result The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value, incl. some metadata. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name render_value_result The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name RenderValueResultDataType The name of the Python class. python_module_name kiara.data_types.included_core_types.internal.render_value The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.internal.render_value.RenderValueResultDataType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

render.dict.as.terminal_renderable

type_name	render.dict.as.terminal_renderable	The registered name for this item type.
documentation	description Render a 'dict' value as a terminal_renderable. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type render.value The module type. module_config constants defaults source_type dict target_type terminal_renderable The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id render.dict.as.terminal_renderable The (unique) id of this operation. operation_details operation_id render.dict.as.terminal_renderable The id of the operation. is_internal_operation True Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema value type dict The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. render_config type dict The type of the value. type_config Configuration for the type, in case it's complex. default A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Instructions/config on how (or what) to render the provided value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema render_value_result type render_value_result The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value, incl. some metadata. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. source_data_type dict The data type that will be rendered. target_data_type terminal_renderable The rendered data type. The operation specific details of this operation. doc description Render a 'dict' value as a terminal_renderable. Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name ValueTypeRenderModule The name of the Python class. python_module_name kiara.modules.included_core_modules.render_value The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.render_value.ValueTypeRenderModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. source_type dict The (kiara) data type to be rendered. target_type terminal_renderable The (kiara) data type of210 the rendered result. The module config. inputs_schema value type dict The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. render_config type dict The type of the value. type_config Configuration for the type, in case it's complex. default A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Instructions/config on how (or what) to render the provided value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema render_value_result type render_value_result The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value, incl. some metadata. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	render_value	The operation types this operation belongs to.
input_fields	value field_name value The field name. field_schema type dict The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name dict The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable True Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name DictValueType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.DictValueType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set). render_config field_name render_config The field name. field_schema type dict The type of the value. type_config Configuration for the type, in case it's complex. default A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Instructions/config on how (or what) to render the provided value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name dict The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable True Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name DictValueType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.DictValueType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	render_value_result field_name render_value_result The field name. field_schema type render_value_result The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value, incl. some metadata. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name render_value_result The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name RenderValueResultDataType The name of the Python class. python_module_name kiara.data_types.included_core_types.internal.render_value The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.internal.render_value.RenderValueResultDataType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

render.internal.as.string

type_name	render.internal.as.string	The registered name for this item type.
documentation	description Render a 'internal' value as a string. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type render.value The module type. module_config constants defaults source_type internal target_type string The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id render.internal.as.string The (unique) id of this operation. operation_details operation_id render.internal.as.string The id of the operation. is_internal_operation True Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema value type internal The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. render_config type dict The type of the value. type_config Configuration for the type, in case it's complex. default A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Instructions/config on how (or what) to render the provided value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema render_value_result type render_value_result The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value, incl. some metadata. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. source_data_type internal The data type that will be rendered. target_data_type string The rendered data type. The operation specific details of this operation. doc description Render a 'internal' value as a string. Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name ValueTypeRenderModule The name of the Python class. python_module_name kiara.modules.included_core_modules.render_value The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.render_value.ValueTypeRenderModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. source_type internal The (kiara) data type to be rendered. target_type string The (kiara) data type of210 the rendered result. The module config. inputs_schema value type internal The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. render_config type dict The type of the value. type_config Configuration for the type, in case it's complex. default A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Instructions/config on how (or what) to render the provided value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema render_value_result type render_value_result The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value, incl. some metadata. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	render_value	The operation types this operation belongs to.
input_fields	value field_name value The field name. field_schema type internal The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name internal The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name InternalType The name of the Python class. python_module_name kiara.data_types.included_core_types.internal The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.internal.InternalType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set). render_config field_name render_config The field name. field_schema type dict The type of the value. type_config Configuration for the type, in case it's complex. default A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Instructions/config on how (or what) to render the provided value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name dict The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable True Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name DictValueType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.DictValueType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	render_value_result field_name render_value_result The field name. field_schema type render_value_result The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value, incl. some metadata. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name render_value_result The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name RenderValueResultDataType The name of the Python class. python_module_name kiara.data_types.included_core_types.internal.render_value The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.internal.render_value.RenderValueResultDataType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.

render.internal.as.terminal_renderable

type_name	render.internal.as.terminal_renderable	The registered name for this item type.
documentation	description Render a 'internal' value as a terminal_renderable. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
operation	module_type render.value The module type. module_config constants defaults source_type internal target_type terminal_renderable The configuration for the module. is_resolved False Whether the configuration of this module was augmented with the module type defaults etc. operation_id render.internal.as.terminal_renderable The (unique) id of this operation. operation_details operation_id render.internal.as.terminal_renderable The id of the operation. is_internal_operation True Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). module_inputs_schema value type internal The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. render_config type dict The type of the value. type_config Configuration for the type, in case it's complex. default A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Instructions/config on how (or what) to render the provided value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The input schemas of the module. module_outputs_schema render_value_result type render_value_result The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value, incl. some metadata. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The output schemas of the module. source_data_type internal The data type that will be rendered. target_data_type terminal_renderable The rendered data type. The operation specific details of this operation. doc description Render a 'internal' value as a terminal_renderable. Short description of the item. doc None Detailed documentation of the item (in markdown). Documentation for this operation. module_details python_class_name ValueTypeRenderModule The name of the Python class. python_module_name kiara.modules.included_core_modules.render_value The name of the Python module this class lives in. full_name kiara.modules.included_core_modules.render_value.ValueTypeRenderModule The full class namespace. module_config constants Value constants for this module. defaults Value defaults for this module. source_type internal The (kiara) data type to be rendered. target_type terminal_renderable The (kiara) data type of210 the rendered result. The module config. inputs_schema value type internal The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. render_config type dict The type of the value. type_config Configuration for the type, in case it's complex. default A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Instructions/config on how (or what) to render the provided value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module input(s). outputs_schema render_value_result type render_value_result The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value, incl. some metadata. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema for the module output(s). The class of the underlying module. metadata Additional metadata for this operation.	The operation instance.
operation_types	render_value	The operation types this operation belongs to.
input_fields	value field_name value The field name. field_schema type internal The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The value to render. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name internal The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name InternalType The name of the Python class. python_module_name kiara.data_types.included_core_types.internal The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.internal.InternalType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set). render_config field_name render_config The field name. field_schema type dict The type of the value. type_config Configuration for the type, in case it's complex. default A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description Instructions/config on how (or what) to render the provided value. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name dict The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable True Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name DictValueType The name of the Python class. python_module_name kiara.data_types.included_core_types The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.DictValueType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required False Whether user input is required (meaning: 'optional' is False, and no default set).	The inputs schema for this operation.
output_fields	render_value_result field_name render_value_result The field name. field_schema type render_value_result The type of the value. type_config Configuration for the type, in case it's complex. default SpecialValue.NOT_SET A default value. optional False Whether this value is required (True), or whether 'None' value is allowed (False). is_constant False Whether the value is a constant. doc description The rendered value, incl. some metadata. Short description of the item. doc None Detailed documentation of the item (in markdown). A description for the value of this input field. The schema of the field. data_type_info data_type_name render_value_result The registered name of this data type. data_type_config The (optional) configuration for this data type. characteristics is_scalar False Whether the data desribed by this data type behaves like a skalar. is_json_serializable False Whether the data can be serialized to json without information loss. Characteristics of this data type. data_type_class python_class_name RenderValueResultDataType The name of the Python class. python_module_name kiara.data_types.included_core_types.internal.render_value The name of the Python module this class lives in. full_name kiara.data_types.included_core_types.internal.render_value.RenderValueResultDataType The full class namespace. The python class that is associated with this model. Information about the data type instance of the associated value. value_required True Whether user input is required (meaning: 'optional' is False, and no default set).	The outputs schema for this operation.