Summary

Package content¶

The kiara main package also contains basic, low-level data-types, modules and operations that are necessary for its core functionality. This page lists all of them.

data_types¶

any: 'Any' type, the parent type for most other types.
boolean: A boolean.
bytes: An array of bytes.
dict: A dictionary.
doc: Documentation for an internal entity.
file: A file.
file_bundle: A bundle of files (like a folder, zip archive, etc.).
internal: 'A 'marker' base data type for data types that are (mainly) used internally in kiara..
internal_model: A value type that is used internally.
none: Type indicating a 'None' value.
[python_object][kiara_info.data_types.python_object]: A 'plain' Python object.
render_scene: A value type to contain information about how to render a value in a specific render scenario.
render_value_result: A value type to contain information about how to render a value in a specific render scenario.
string: A string.
terminal_renderable: A list of renderable objects, used in the 'rich' Python library, to print to the terminal or in Jupyter.

module_types¶

create.file.from.bytes: Import a file from a byte array.
deserialize.file: Deserialize data to a 'file' value instance.
deserialize.file_bundle: Deserialize data to a 'file' value instance.
deserialize.from_json: -- n/a --
export.file: Export files.
file_bundle.pick.file: Pick a single file from a file_bundle value.
file_bundle.pick.sub_folder: Pick a sub-folder from a file_bundle, resulting in a new file_bundle.
import.local.file: Import a file from the local filesystem.
import.local.file_bundle: Import a folder (file_bundle) from the local filesystem.
load.bytes: -- n/a --
load.internal_model: -- n/a --
load.string: -- n/a --
mock: -- n/a --
pipeline: A utility module to run multiple connected inner-modules and present it as its own entity.
pretty_print.any.value: -- n/a --
pretty_print.value: -- n/a --
render.value: A module that uses render methods attached to DataType classes.
unpickle.value: -- n/a --
value.extract_metadata: Base class to use when writing a module to extract metadata from a file.

kiara_model_types¶

metadata.authors: Information about all authors of a resource.
metadata.context: Information about the context of a resource.
metadata.documentation: Documentation about a resource.
instance.value_schema: The schema of a value.
instance.module_config: Base class that describes the configuration a [KiaraModule][kiara.module.KiaraModule] class accepts.
instance.module_config.pipeline: A class to hold the configuration for a [PipelineModule][kiara.pipeline.module.PipelineModule].
instance.manifest: A class to hold the type and configuration for a module instance.
instance.manifest_with_inputs: -- n/a --
instance.job_config: -- n/a --
instance.job_record: -- n/a --
instance.value_pedigree: -- n/a --
instance.pipeline_step: A step within a pipeline-structure, includes information about it's connection(s) and other metadata.
instance.operation: -- n/a --
instance.destiny: A destiny is basically a link to a potential future transformation result involving one or several values as input.
instance.execution_context: -- n/a --
instance.active_job: -- n/a --
job_matcher: -- n/a --
instance.wrapped_python_class: Python class and module information.
metadata.kiara_module_class: -- n/a --
metadata.serialized_data: -- n/a --
instance.serialization_result: -- n/a --
instance.persisted_data: -- n/a --
info.data_type_instance: -- n/a --
instance.value_details: A wrapper class that manages and retieves value data and its details.
instance.value: -- n/a --
instance.unloadable_data: A special 'marker' model, indicating that the data of value can't be loaded.
instance.value_map.readonly: -- n/a --
instance.value_map.writeable: -- n/a --
instance.value_map.aliases: A model class that holds a tree of values and their schemas.
instance.operation_details: -- n/a --
instance.operation_details.base: -- n/a --
instance.operation_config.manifest: -- n/a --
instance.operation_config.pipeline: -- n/a --
filter: -- n/a --
info.pipeline_stage: -- n/a --
pipeline_stages: -- n/a --
info.pipeline_step: -- n/a --
instance.pipeline_structure: An object that holds one or several steps, and describes the connections between them.
info.archive_type: -- n/a --
archive_info: -- n/a --
ki_archive_info: -- n/a --
info.pipeline: -- n/a --
info.workflow: -- n/a --
info.archive_types: -- n/a --
info.archives: -- n/a --
info.pipelines: -- n/a --
info.workflows: -- n/a --
context_info: -- n/a --
kiara_metadata: -- n/a --
instance.kiara_metadata.comment: -- n/a --
info.runtime.python: -- n/a --
info.runtime.kiara_plugins: -- n/a --
info.runtime.os: Manages information about the OS this kiara instance is running in.
instance.render_scene: -- n/a --
render_value_result: Object containing all the result properties of a 'render_value' operation.
value_matcher: An object describing requirements values should satisfy in order to be included in a query result.
metadata.python_class: Python class and module information.
metadata.file: File stats.
metadata.file_bundle: File bundle stats.
instance.pipeline_state: -- n/a --
workflow_state: -- n/a --
instance.workflow: -- n/a --
instance.data.file: Describes properties for the 'file' value type.
instance.data.file_bundle: Describes properties for the 'file_bundle' value type.
info.kiara_model: -- n/a --
info.metadata_type: -- n/a --
info.data_type: -- n/a --
info.kiara_module_type: -- n/a --
info.operation_type: -- n/a --
info.value: -- n/a --
info.pipeline_structure: -- n/a --
info.operation: -- n/a --
renderer_info: -- n/a --
kiara_plugin_info: -- n/a --
job_info: -- n/a --
info.kiara_models: -- n/a --
info.metadata_types: -- n/a --
info.data_types: -- n/a --
info.module_types: -- n/a --
info.operation_types: -- n/a --
values_info: -- n/a --
info.operations: -- n/a --
renderer_infos: -- n/a --
kiara_plugin_infos: -- n/a --
jobs_info: -- n/a --
metadata.module_config: -- n/a --
instance.job_desc: An object describing a compute job with both raw or referenced inputs.
instance.kiarchive: -- n/a --
workflow_matcher: An object describing requirements values should satisfy in order to be included in a query result.

operation_types¶

create_from: Create a dataset from a dataset of another value.
custom_module: -- n/a --
deserialize: 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.
export_as: -- n/a --
extract_metadata: An operation that extracts metadata of a specific type from value data.
filter: -- n/a --
import_data: -- n/a --
pipeline: -- n/a --
pretty_print: An operation that takes a value, and renders into a format that can be printed for output..
render_value: An operation that renders a value.

operations¶

create.file.from.bytes: Import a file from a byte array.
deserialize.bytes.as.python_object: -- n/a --
deserialize.file.as.python_object: -- n/a --
deserialize.file_bundle.as.python_object: -- n/a --
deserialize.from_json: -- n/a --
deserialize.internal_model.as.python_object: -- n/a --
deserialize.string.as.python_object: -- n/a --
deserialize.value: -- n/a --
export.file.as.file: -- n/a --
extract.file.metadata.from.file: Extract 'file' metadata for value type 'file'.
extract.file_bundle.metadata.from.file_bundle: Extract 'file_bundle' metadata for value type 'file_bundle'.
extract.kiara_model_list.metadata.from.kiara_model_list: Extract 'kiara_model_list' metadata for value type 'kiara_model_list'.
extract.kiara_model_schema.metadata.from.kiara_model: Extract 'kiara_model_schema' metadata for value type 'kiara_model'.
extract.kiara_model_schema.metadata.from.kiara_model_list: Extract 'kiara_model_schema' metadata for value type 'kiara_model_list'.
extract.python_class.metadata: Extract 'python_class' metadata for value type 'any'.
file_bundle.pick.file: Pick a single file from a file_bundle value.
file_bundle.pick.sub_folder: Pick a sub-folder from a file_bundle, resulting in a new file_bundle.
import.local.file: Import a file from the local filesystem.
import.local.file_bundle: Import a folder (file_bundle) from the local filesystem.
pretty_print.as.string: Pretty print a any value as a string.
pretty_print.as.terminal_renderable: Pretty print a any value as a terminal_renderable.
pretty_print.internal.as.string: Pretty print a internal value as a string.
pretty_print.internal.as.terminal_renderable: Pretty print a internal value as a terminal_renderable.
pretty_print.none.as.string: Pretty print a none value as a string.
pretty_print.none.as.terminal_renderable: Pretty print a none value as a terminal_renderable.
pretty_print.string.as.bytes: Pretty print a string value as a bytes.
render.as.string: Render a 'any' value as a string.
render.as.terminal_renderable: Render a 'any' value as a terminal_renderable.
render.dict.as.terminal_renderable: Render a 'dict' value as a terminal_renderable.
render.internal.as.string: Render a 'internal' value as a string.
render.internal.as.terminal_renderable: Render a 'internal' value as a terminal_renderable.