Skip to content

operation_types

create_from

type_name create_from The registered name for this item type.
documentation

Create a dataset from a dataset of another value.

This operation always has at least one input named after the source type, and one output named after the target type. It can, in addition, also have other, optional inputs, to control how exactly the target value is created.

Documentation for the item.
authors Information about authorship for the item.
context
tags
labels
  • package: kiara
references
Generic properties of this item (description, tags, labels, references, ...).
python_class
python_class_name CreateFromOperationType The name of the Python class.
python_module_name kiara.operations.included_core_operations.create_from The name of the Python module this class lives in.
full_name kiara.operations.included_core_operations.create_from.CreateFromOperationType The full class namespace.
The python class that implements this module type.

custom_module

type_name custom_module The registered name for this item type.
documentation

-- n/a --

Documentation for the item.
authors Information about authorship for the item.
context
tags
labels
  • package: kiara
references
Generic properties of this item (description, tags, labels, references, ...).
python_class
python_class_name CustomModuleOperationType The name of the Python class.
python_module_name kiara.operations.included_core_operations The name of the Python module this class lives in.
full_name kiara.operations.included_core_operations.CustomModuleOperationType The full class namespace.
The python class that implements this module type.

deserialize

type_name deserialize The registered name for this item type.
documentation

An operation that takes a value, and serializes it into the format suitable to the [serialized_value][kiara.data_types.included_core_types.SeriailzedValue] value type.

For a module profile to be picked up by this operation type, it needs to have:

  • exactly one output field of type serialized_value
  • either one of (in this order):
    • exactly one input field
    • one input field where the field name equals the type name
    • an input field called 'value'
Documentation for the item.
authors Information about authorship for the item.
context
tags
labels
  • package: kiara
references
Generic properties of this item (description, tags, labels, references, ...).
python_class
python_class_name DeSerializeOperationType The name of the Python class.
python_module_name kiara.operations.included_core_operations.serialize The name of the Python module this class lives in.
full_name kiara.operations.included_core_operations.serialize.DeSerializeOperationType The full class namespace.
The python class that implements this module type.

export_as

type_name export_as The registered name for this item type.
documentation

-- n/a --

Documentation for the item.
authors Information about authorship for the item.
context
tags
labels
  • package: kiara
references
Generic properties of this item (description, tags, labels, references, ...).
python_class
python_class_name ExportAsOperationType The name of the Python class.
python_module_name kiara.operations.included_core_operations.export_as The name of the Python module this class lives in.
full_name kiara.operations.included_core_operations.export_as.ExportAsOperationType The full class namespace.
The python class that implements this module type.

extract_metadata

type_name extract_metadata The registered name for this item type.
documentation

An operation that extracts metadata of a specific type from value data.

For a module profile to be picked up by this operation type, it needs to have:

  • exactly one input field
  • that input field must have the same name as its value type, or be 'value'
  • exactly one output field, whose field name is called 'value_metadata', and where the value has the type 'internal_model'
Documentation for the item.
authors Information about authorship for the item.
context
tags
labels
  • package: kiara
references
Generic properties of this item (description, tags, labels, references, ...).
python_class
python_class_name ExtractMetadataOperationType The name of the Python class.
python_module_name kiara.operations.included_core_operations.metadata The name of the Python module this class lives in.
full_name kiara.operations.included_core_operations.metadata.ExtractMetadataOperationType The full class namespace.
The python class that implements this module type.

filter

type_name filter The registered name for this item type.
documentation

-- n/a --

Documentation for the item.
authors Information about authorship for the item.
context
tags
labels
  • package: kiara
references
Generic properties of this item (description, tags, labels, references, ...).
python_class
python_class_name FilterOperationType The name of the Python class.
python_module_name kiara.operations.included_core_operations.filter The name of the Python module this class lives in.
full_name kiara.operations.included_core_operations.filter.FilterOperationType The full class namespace.
The python class that implements this module type.

import_data

type_name import_data The registered name for this item type.
documentation

-- n/a --

Documentation for the item.
authors Information about authorship for the item.
context
tags
labels
  • package: kiara
references
Generic properties of this item (description, tags, labels, references, ...).
python_class
python_class_name ImportDataOperationType The name of the Python class.
python_module_name kiara.operations.included_core_operations.import_data The name of the Python module this class lives in.
full_name kiara.operations.included_core_operations.import_data.ImportDataOperationType The full class namespace.
The python class that implements this module type.

pipeline

type_name pipeline The registered name for this item type.
documentation

-- n/a --

Documentation for the item.
authors Information about authorship for the item.
context
tags
labels
  • package: kiara
references
Generic properties of this item (description, tags, labels, references, ...).
python_class
python_class_name PipelineOperationType The name of the Python class.
python_module_name kiara.operations.included_core_operations.pipeline The name of the Python module this class lives in.
full_name kiara.operations.included_core_operations.pipeline.PipelineOperationType The full class namespace.
The python class that implements this module type.

pretty_print

type_name pretty_print The registered name for this item type.
documentation

An operation that takes a value, and renders into a format that can be printed for output..

For a module profile to be picked up by this operation type, it needs to have:

  • exactly one output field named "rendered_value"
  • exactly two input fields, one of them named after the type it supports, and the other called 'render_config', of type 'dict'
Documentation for the item.
authors Information about authorship for the item.
context
tags
labels
  • package: kiara
references
Generic properties of this item (description, tags, labels, references, ...).
python_class
python_class_name PrettyPrintOperationType The name of the Python class.
python_module_name kiara.operations.included_core_operations.pretty_print The name of the Python module this class lives in.
full_name kiara.operations.included_core_operations.pretty_print.PrettyPrintOperationType The full class namespace.
The python class that implements this module type.

render_value

type_name render_value The registered name for this item type.
documentation

An operation that renders a value.

A 'render_value' operation typically is named follwing the pattern:

 'render.<source_type>.as.<target_type>'

It has 2 inputs:

  • 'value': the value to render
  • 'reneer_config' a target type-specific configuration dict

And one output:

  • render_value_result: using internal type [RenderValueResultDataType][kiara.data_types.included_core_types.internal.render_value.RenderValueResultDataType]
Documentation for the item.
authors Information about authorship for the item.
context
tags
labels
  • package: kiara
references
Generic properties of this item (description, tags, labels, references, ...).
python_class
python_class_name RenderValueOperationType The name of the Python class.
python_module_name kiara.operations.included_core_operations.render_value The name of the Python module this class lives in.
full_name kiara.operations.included_core_operations.render_value.RenderValueOperationType The full class namespace.
The python class that implements this module type.