Skip to content

kiara_model_types

network_graph_properties

                                                                                
 Documentation                                                                  
                 Network data stats.                                            
                                                                                
 Author(s)                                                                      
                                                                                
 Context                                                                        
                 Tags         network_analysis                                  
                 Labels       package: kiara_plugin.network_analysis            
                 References   source_repo:                                      
                              https://github.com/DHARPA-Project/kiara_plugin…   
                              documentation:                                    
                              https://DHARPA-Project.github.io/kiara_plugin.…   
                                                                                
 Python class                                                                   
                 python_class_name    NetworkGraphProperties                    
                 python_module_name   kiara_plugin.network_analysis.models      
                 full_name            kiara_plugin.network_analysis.models.N…   
                                                                                
                                                                                

instance.network_data

                                                                                
 Documentation                                                                  
                 A helper class to access and query network datasets.           
                                                                                
                 This class provides different ways to access the underlying    
                 network data, most notably via sql and as networkx Graph       
                 object.                                                        
                                                                                
                 Internally, network data is stored as 2 Arrow tables with      
                 the edges stored in a table called 'edges' and the nodes in    
                 a table called 'nodes'. The edges table must have (at least)   
                 the following columns: '_source', '_target'. The nodes table   
                 must have (at least) the following columns: '_id' (integer),   
                 '_label' (string).                                             
                                                                                
                 By convention, kiara will add columns prefixed with an         
                 underscore if the values in it have internal 'meaning',        
                 normal/original attributes are stored in columns without       
                 that prefix.                                                   
                                                                                
 Author(s)                                                                      
                                                                                
 Context                                                                        
                 Tags         network_analysis                                  
                 Labels       package: kiara_plugin.network_analysis            
                 References   source_repo:                                      
                              https://github.com/DHARPA-Project/kiara_plugin…   
                              documentation:                                    
                              https://DHARPA-Project.github.io/kiara_plugin.…   
                                                                                
 Python class                                                                   
                 python_class_name    NetworkData                               
                 python_module_name   kiara_plugin.network_analysis.models      
                 full_name            kiara_plugin.network_analysis.models.N…   
                                                                                
                                                                                

input.attribute_map_strategy

                                                                                
 Documentation                                                                  
                 -- n/a --                                                      
                                                                                
 Author(s)                                                                      
                                                                                
 Context                                                                        
                 Tags         network_analysis                                  
                 Labels       package: kiara_plugin.network_analysis            
                 References   source_repo:                                      
                              https://github.com/DHARPA-Project/kiara_plugin…   
                              documentation:                                    
                              https://DHARPA-Project.github.io/kiara_plugin.…   
                                                                                
 Python class                                                                   
                 python_class_name    AttributeMapStrategy                      
                 python_module_name   kiara_plugin.network_analysis.models.i…   
                 full_name            kiara_plugin.network_analysis.models.i…   
                                                                                
                                                                                

metadata.network_node_attribute

                                                                                
 Documentation                                                                  
                 -- n/a --                                                      
                                                                                
 Author(s)                                                                      
                                                                                
 Context                                                                        
                 Tags         network_analysis                                  
                 Labels       package: kiara_plugin.network_analysis            
                 References   source_repo:                                      
                              https://github.com/DHARPA-Project/kiara_plugin…   
                              documentation:                                    
                              https://DHARPA-Project.github.io/kiara_plugin.…   
                                                                                
 Python class                                                                   
                 python_class_name    NetworkNodeAttributeMetadata              
                 python_module_name   kiara_plugin.network_analysis.models.m…   
                 full_name            kiara_plugin.network_analysis.models.m…   
                                                                                
                                                                                

metadata.network_edge_attribute

                                                                                
 Documentation                                                                  
                 -- n/a --                                                      
                                                                                
 Author(s)                                                                      
                                                                                
 Context                                                                        
                 Tags         network_analysis                                  
                 Labels       package: kiara_plugin.network_analysis            
                 References   source_repo:                                      
                              https://github.com/DHARPA-Project/kiara_plugin…   
                              documentation:                                    
                              https://DHARPA-Project.github.io/kiara_plugin.…   
                                                                                
 Python class                                                                   
                 python_class_name    NetworkEdgeAttributeMetadata              
                 python_module_name   kiara_plugin.network_analysis.models.m…   
                 full_name            kiara_plugin.network_analysis.models.m…