Available pipeline module types¶
This page contains a list of all available Kiara pipeline module types, and their details.
Note
The formatting here will be improved later on, for now this should be enough to get the important details of each module type.
array.restore¶
Documentation
Load a column from a table object, returning an array.
Origin
Authors Markus Binsteiner (markus@frkl.io)
Context
Tags array, pipeline, core
Labels package: kiara_modules.core
pipeline: yes
References source_repo:
https://github.com/DHARPA-Project/kiara_modu…
documentation:
https://dharpa.org/kiara_modules.core/
module_doc:
https://dharpa.org/kiara_modules.core/latest…
Module config
Field Type Description Required
────────────────────────────────────────────────────────────
constants object Value no
constants for
this module.
defaults object Value no
defaults for
this module.
steps array A list of no
steps/modules
of this
pipeline, and
their
connections.
input_aliases -- check A map of no
source -- input
aliases, with
the
calculated
(<step_id>__…
-- double
underscore!)
name as key,
and a string
(the
resulting
workflow
input alias)
as value.
Check the
documentation
for the
config class
for which
marker
strings can
be used to
automatically
create this
map if
possible.
output_aliases -- check A map of no
source -- output
aliases, with
the
calculated
(<step_id>__…
-- double
underscore!)
name as key,
and a string
(the
resulting
workflow
output alias)
as value.
Check the
documentation
for the
config class
for which
marker
strings can
be used to
automatically
create this
map if
possible.
documentation string Documentation no
about what
the pipeline
does.
context object Metadata for no
this
workflow.
Module config -- no config --
Python class
class_name ArrayRestorePipelineModule
module_name kiara_modules.core.array
full_name kiara_modules.core.array.ArrayRestorePipeli…
Pipeline config ────────────────────────────────────────────────────────────
{
"constants": {},
"defaults": {},
"steps": [
{
"module_type": "table.load",
"module_config": {},
"doc": {
"description": "-- n/a --",
"doc": null
},
"step_id": "load_table",
"input_links": {}
},
{
"module_type": "table.cut_column",
"module_config": {},
"doc": {
"description": "-- n/a --",
"doc": null
},
"step_id": "cut_column",
"input_links": {
"table": [
{
"step_id": "load_table",
"value_name": "table",
"sub_value": null
}
]
}
}
],
"input_aliases": "auto",
"output_aliases": "auto",
"documentation": "Load a column from a table object, re…
"context": {},
"module_type_name": "restore"
}
────────────────────────────────────────────────────────────
logic.nand¶
Documentation
Returns 'False' if both inputs are 'True'.
Origin
Authors Markus Binsteiner (markus@frkl.io)
Context
Tags pipeline, core
Labels package: kiara_modules.core
pipeline: yes
References source_repo:
https://github.com/DHARPA-Project/kiara_modu…
documentation:
https://dharpa.org/kiara_modules.core/
module_doc:
https://dharpa.org/kiara_modules.core/latest…
Module config
Field Type Description Required
────────────────────────────────────────────────────────────
constants object Value no
constants for
this module.
defaults object Value no
defaults for
this module.
steps array A list of no
steps/modules
of this
pipeline, and
their
connections.
input_aliases -- check A map of no
source -- input
aliases, with
the
calculated
(<step_id>__…
-- double
underscore!)
name as key,
and a string
(the
resulting
workflow
input alias)
as value.
Check the
documentation
for the
config class
for which
marker
strings can
be used to
automatically
create this
map if
possible.
output_aliases -- check A map of no
source -- output
aliases, with
the
calculated
(<step_id>__…
-- double
underscore!)
name as key,
and a string
(the
resulting
workflow
output alias)
as value.
Check the
documentation
for the
config class
for which
marker
strings can
be used to
automatically
create this
map if
possible.
documentation string Documentation no
about what
the pipeline
does.
context object Metadata for no
this
workflow.
Module config -- no config --
Python class
class_name LogicNandPipelineModule
module_name kiara_modules.core.logic
full_name kiara_modules.core.logic.LogicNandPipelineM…
Pipeline config ────────────────────────────────────────────────────────────
{
"constants": {},
"defaults": {},
"steps": [
{
"module_type": "logic.and",
"module_config": {},
"doc": {
"description": "-- n/a --",
"doc": null
},
"step_id": "and",
"input_links": {}
},
{
"module_type": "logic.not",
"module_config": {},
"doc": {
"description": "-- n/a --",
"doc": null
},
"step_id": "not",
"input_links": {
"a": [
{
"step_id": "and",
"value_name": "y",
"sub_value": null
}
]
}
}
],
"input_aliases": {
"and__a": "a",
"and__b": "b"
},
"output_aliases": {
"not__y": "y"
},
"documentation": "Returns 'False' if both inputs are 'T…
"context": {},
"module_type_name": "nand"
}
────────────────────────────────────────────────────────────
logic.nor¶
Documentation
Returns 'True' if both inputs are 'False'.
Origin
Authors Markus Binsteiner (markus@frkl.io)
Context
Tags pipeline, core
Labels package: kiara_modules.core
pipeline: yes
References source_repo:
https://github.com/DHARPA-Project/kiara_modu…
documentation:
https://dharpa.org/kiara_modules.core/
module_doc:
https://dharpa.org/kiara_modules.core/latest…
Module config
Field Type Description Required
────────────────────────────────────────────────────────────
constants object Value no
constants for
this module.
defaults object Value no
defaults for
this module.
steps array A list of no
steps/modules
of this
pipeline, and
their
connections.
input_aliases -- check A map of no
source -- input
aliases, with
the
calculated
(<step_id>__…
-- double
underscore!)
name as key,
and a string
(the
resulting
workflow
input alias)
as value.
Check the
documentation
for the
config class
for which
marker
strings can
be used to
automatically
create this
map if
possible.
output_aliases -- check A map of no
source -- output
aliases, with
the
calculated
(<step_id>__…
-- double
underscore!)
name as key,
and a string
(the
resulting
workflow
output alias)
as value.
Check the
documentation
for the
config class
for which
marker
strings can
be used to
automatically
create this
map if
possible.
documentation string Documentation no
about what
the pipeline
does.
context object Metadata for no
this
workflow.
Module config -- no config --
Python class
class_name LogicNorPipelineModule
module_name kiara_modules.core.logic
full_name kiara_modules.core.logic.LogicNorPipelineMo…
Pipeline config ────────────────────────────────────────────────────────────
{
"constants": {},
"defaults": {},
"steps": [
{
"module_type": "logic.or",
"module_config": {},
"doc": {
"description": "-- n/a --",
"doc": null
},
"step_id": "or",
"input_links": {}
},
{
"module_type": "logic.not",
"module_config": {},
"doc": {
"description": "-- n/a --",
"doc": null
},
"step_id": "not",
"input_links": {
"a": [
{
"step_id": "or",
"value_name": "y",
"sub_value": null
}
]
}
}
],
"input_aliases": {
"or__a": "a",
"or__b": "b"
},
"output_aliases": {
"not__y": "y"
},
"documentation": "Returns 'True' if both inputs are 'Fa…
"context": {},
"module_type_name": "nor"
}
────────────────────────────────────────────────────────────
logic.xor¶
Documentation
Returns 'True' if exactly one of it's two inputs is
'True'.
Origin
Authors Markus Binsteiner (markus@frkl.io)
Context
Tags pipeline, core
Labels package: kiara_modules.core
pipeline: yes
References source_repo:
https://github.com/DHARPA-Project/kiara_modu…
documentation:
https://dharpa.org/kiara_modules.core/
module_doc:
https://dharpa.org/kiara_modules.core/latest…
Module config
Field Type Description Required
────────────────────────────────────────────────────────────
constants object Value no
constants for
this module.
defaults object Value no
defaults for
this module.
steps array A list of no
steps/modules
of this
pipeline, and
their
connections.
input_aliases -- check A map of no
source -- input
aliases, with
the
calculated
(<step_id>__…
-- double
underscore!)
name as key,
and a string
(the
resulting
workflow
input alias)
as value.
Check the
documentation
for the
config class
for which
marker
strings can
be used to
automatically
create this
map if
possible.
output_aliases -- check A map of no
source -- output
aliases, with
the
calculated
(<step_id>__…
-- double
underscore!)
name as key,
and a string
(the
resulting
workflow
output alias)
as value.
Check the
documentation
for the
config class
for which
marker
strings can
be used to
automatically
create this
map if
possible.
documentation string Documentation no
about what
the pipeline
does.
context object Metadata for no
this
workflow.
Module config -- no config --
Python class
class_name LogicXorPipelineModule
module_name kiara_modules.core.logic
full_name kiara_modules.core.logic.LogicXorPipelineMo…
Pipeline config ────────────────────────────────────────────────────────────
{
"constants": {},
"defaults": {},
"steps": [
{
"module_type": "logic.or",
"module_config": {},
"doc": {
"description": "-- n/a --",
"doc": null
},
"step_id": "or",
"input_links": {}
},
{
"module_type": "logic.nand",
"module_config": {},
"doc": {
"description": "-- n/a --",
"doc": null
},
"step_id": "nand",
"input_links": {}
},
{
"module_type": "logic.and",
"module_config": {},
"doc": {
"description": "-- n/a --",
"doc": null
},
"step_id": "and",
"input_links": {
"a": [
{
"step_id": "or",
"value_name": "y",
"sub_value": null
}
],
"b": [
{
"step_id": "nand",
"value_name": "y",
"sub_value": null
}
]
}
}
],
"input_aliases": {
"or__a": "a",
"or__b": "b",
"nand__a": "a",
"nand__b": "b"
},
"output_aliases": {
"and__y": "y"
},
"documentation": "Returns 'True' if exactly one of it's…
"context": {},
"module_type_name": "xor"
}
────────────────────────────────────────────────────────────
table.filter.by_date¶
Documentation
Filter a table by a date or date range.
Origin
Authors Markus Binsteiner (markus@frkl.io)
Context
Tags pipeline, core
Labels package: kiara_modules.core
pipeline: yes
References source_repo:
https://github.com/DHARPA-Project/kiara_modu…
documentation:
https://dharpa.org/kiara_modules.core/
module_doc:
https://dharpa.org/kiara_modules.core/latest…
Module config
Field Type Description Required
────────────────────────────────────────────────────────────
constants object Value no
constants for
this module.
defaults object Value no
defaults for
this module.
steps array A list of no
steps/modules
of this
pipeline, and
their
connections.
input_aliases -- check A map of no
source -- input
aliases, with
the
calculated
(<step_id>__…
-- double
underscore!)
name as key,
and a string
(the
resulting
workflow
input alias)
as value.
Check the
documentation
for the
config class
for which
marker
strings can
be used to
automatically
create this
map if
possible.
output_aliases -- check A map of no
source -- output
aliases, with
the
calculated
(<step_id>__…
-- double
underscore!)
name as key,
and a string
(the
resulting
workflow
output alias)
as value.
Check the
documentation
for the
config class
for which
marker
strings can
be used to
automatically
create this
map if
possible.
documentation string Documentation no
about what
the pipeline
does.
context object Metadata for no
this
workflow.
Module config -- no config --
Python class
class_name TableFilterByDatePipelineModule
module_name kiara_modules.core.table
full_name kiara_modules.core.table.TableFilterByDateP…
Pipeline config ────────────────────────────────────────────────────────────
{
"constants": {},
"defaults": {},
"steps": [
{
"module_type": "table.map_column",
"module_config": {
"module_type": "date.range_check",
"input_name": "date"
},
"doc": {
"description": "-- n/a --",
"doc": null
},
"step_id": "create_filter_mask",
"input_links": {}
},
{
"module_type": "table.filter.with_mask",
"module_config": {},
"doc": {
"description": "-- n/a --",
"doc": null
},
"step_id": "filtered_table",
"input_links": {
"mask": [
{
"step_id": "create_filter_mask",
"value_name": "array",
"sub_value": null
}
]
}
}
],
"input_aliases": {
"create_filter_mask__table": "table",
"create_filter_mask__column_name": "column_name",
"create_filter_mask__earliest": "earliest",
"create_filter_mask__latest": "latest",
"filtered_table__table": "table"
},
"output_aliases": "auto",
"documentation": "Filter a table by a date or date rang…
"context": {},
"module_type_name": "by_date"
}
────────────────────────────────────────────────────────────