Skip to content

operation_types

create_from

                                                                                                                                            
 Documentation                                                                                                                              
                 -- n/a --                                                                                                                  
                                                                                                                                            
 Author(s)                                                                                                                                  
                 Markus Binsteiner   markus@frkl.io                                                                                         
                                                                                                                                            
 Context                                                                                                                                    
                 Labels       package: kiara                                                                                                
                 References   source_repo: https://github.com/DHARPA-Project/kiara                                                          
                              documentation: https://dharpa.org/kiara_documentation/                                                        
                                                                                                                                            
 Python class                                                                                                                               
                 python_class_name    CreateFromOperationType                                                                               
                 python_module_name   kiara.operations.included_core_operations.create_from                                                 
                 full_name            kiara.operations.included_core_operations.create_from.CreateFromOperationType                         
                                                                                                                                            
                                                                                                                                            

custom_module

                                                                                                                                            
 Documentation                                                                                                                              
                 -- n/a --                                                                                                                  
                                                                                                                                            
 Author(s)                                                                                                                                  
                 Markus Binsteiner   markus@frkl.io                                                                                         
                                                                                                                                            
 Context                                                                                                                                    
                 Labels       package: kiara                                                                                                
                 References   source_repo: https://github.com/DHARPA-Project/kiara                                                          
                              documentation: https://dharpa.org/kiara_documentation/                                                        
                                                                                                                                            
 Python class                                                                                                                               
                 python_class_name    CustomModuleOperationType                                                                             
                 python_module_name   kiara.operations.included_core_operations                                                             
                 full_name            kiara.operations.included_core_operations.CustomModuleOperationType                                   
                                                                                                                                            
                                                                                                                                            

deserialize

                                                                                                                                            
 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'                                                                                        
                                                                                                                                            
 Author(s)                                                                                                                                  
                 Markus Binsteiner   markus@frkl.io                                                                                         
                                                                                                                                            
 Context                                                                                                                                    
                 Labels       package: kiara                                                                                                
                 References   source_repo: https://github.com/DHARPA-Project/kiara                                                          
                              documentation: https://dharpa.org/kiara_documentation/                                                        
                                                                                                                                            
 Python class                                                                                                                               
                 python_class_name    DeSerializeOperationType                                                                              
                 python_module_name   kiara.operations.included_core_operations.serialize                                                   
                 full_name            kiara.operations.included_core_operations.serialize.DeSerializeOperationType                          
                                                                                                                                            
                                                                                                                                            

export_as

                                                                                                                                            
 Documentation                                                                                                                              
                 -- n/a --                                                                                                                  
                                                                                                                                            
 Author(s)                                                                                                                                  
                 Markus Binsteiner   markus@frkl.io                                                                                         
                                                                                                                                            
 Context                                                                                                                                    
                 Labels       package: kiara                                                                                                
                 References   source_repo: https://github.com/DHARPA-Project/kiara                                                          
                              documentation: https://dharpa.org/kiara_documentation/                                                        
                                                                                                                                            
 Python class                                                                                                                               
                 python_class_name    ExportAsOperationType                                                                                 
                 python_module_name   kiara.operations.included_core_operations.export_as                                                   
                 full_name            kiara.operations.included_core_operations.export_as.ExportAsOperationType                             
                                                                                                                                            
                                                                                                                                            

extract_metadata

                                                                                                                                            
 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'                                                                                                        
                                                                                                                                            
 Author(s)                                                                                                                                  
                 Markus Binsteiner   markus@frkl.io                                                                                         
                                                                                                                                            
 Context                                                                                                                                    
                 Labels       package: kiara                                                                                                
                 References   source_repo: https://github.com/DHARPA-Project/kiara                                                          
                              documentation: https://dharpa.org/kiara_documentation/                                                        
                                                                                                                                            
 Python class                                                                                                                               
                 python_class_name    ExtractMetadataOperationType                                                                          
                 python_module_name   kiara.operations.included_core_operations.metadata                                                    
                 full_name            kiara.operations.included_core_operations.metadata.ExtractMetadataOperationType                       
                                                                                                                                            
                                                                                                                                            

pipeline

                                                                                                                                            
 Documentation                                                                                                                              
                 -- n/a --                                                                                                                  
                                                                                                                                            
 Author(s)                                                                                                                                  
                 Markus Binsteiner   markus@frkl.io                                                                                         
                                                                                                                                            
 Context                                                                                                                                    
                 Labels       package: kiara                                                                                                
                 References   source_repo: https://github.com/DHARPA-Project/kiara                                                          
                              documentation: https://dharpa.org/kiara_documentation/                                                        
                                                                                                                                            
 Python class                                                                                                                               
                 python_class_name    PipelineOperationType                                                                                 
                 python_module_name   kiara.operations.included_core_operations.pipeline                                                    
                 full_name            kiara.operations.included_core_operations.pipeline.PipelineOperationType                              
                                                                                                                                            
                                                                                                                                            

pretty_print

                                                                                                                                            
 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'                                                                                                                  
                                                                                                                                            
 Author(s)                                                                                                                                  
                 Markus Binsteiner   markus@frkl.io                                                                                         
                                                                                                                                            
 Context                                                                                                                                    
                 Labels       package: kiara                                                                                                
                 References   source_repo: https://github.com/DHARPA-Project/kiara                                                          
                              documentation: https://dharpa.org/kiara_documentation/                                                        
                                                                                                                                            
 Python class                                                                                                                               
                 python_class_name    PrettyPrintOperationType                                                                              
                 python_module_name   kiara.operations.included_core_operations.pretty_print                                                
                 full_name            kiara.operations.included_core_operations.pretty_print.PrettyPrintOperationType                       
                                                                                                                                            
                                                                                                                                            

render_value

                                                                                                                                            
 Documentation                                                                                                                              
                 An operation that renders a value.                                                                                         
                                                                                                                                            
 Author(s)                                                                                                                                  
                 Markus Binsteiner   markus@frkl.io                                                                                         
                                                                                                                                            
 Context                                                                                                                                    
                 Labels       package: kiara                                                                                                
                 References   source_repo: https://github.com/DHARPA-Project/kiara                                                          
                              documentation: https://dharpa.org/kiara_documentation/                                                        
                                                                                                                                            
 Python class                                                                                                                               
                 python_class_name    RenderValueOperationType                                                                              
                 python_module_name   kiara.operations.included_core_operations.render_value                                                
                 full_name            kiara.operations.included_core_operations.render_value.RenderValueOperationType