Skip to content

metadata

Attributes

NODE_ID_COLUMN_METADATA = NetworkNodeAttributeMetadata(doc=NODE_ID_TEXT, computed_attribute=True) module-attribute

NODE_LABEL_COLUMN_METADATA = NetworkNodeAttributeMetadata(doc=NODE_LABEL_TEXT, computed_attribute=True) module-attribute

NODE_COUNT_EDGES_COLUMN_METADATA = NetworkNodeAttributeMetadata(doc=NODE_COUNT_EDGES_TEXT, computed_attribute=True) module-attribute

NODE_DEGREE_COLUMN_METADATA = NetworkEdgeAttributeMetadata(doc=UNWEIGHTED_DEGREE_CENTRALITY_TEXT, computed_attribute=True) module-attribute

NODE_COUND_EDGES_MULTI_COLUMN_METADATA = NetworkNodeAttributeMetadata(doc=NODE_COUNT_EDGES_MULTI_TEXT, computed_attribute=True) module-attribute

NODE_DEGREE_MULTI_COLUMN_METADATA = NetworkEdgeAttributeMetadata(doc=UNWEIGHTED_DEGREE_CENTRALITY_TEXT, computed_attribute=True) module-attribute

NODE_COUNT_IN_EDGES_COLUMN_METADATA = NetworkNodeAttributeMetadata(doc=NODE_COUNT_IN_EDGES_TEXT, computed_attribute=True) module-attribute

NODE_COUNT_IN_EDGES_MULTI_COLUMN_METADATA = NetworkNodeAttributeMetadata(doc=NODE_COUNT_IN_EDGES_MULTI_TEXT, computed_attribute=True) module-attribute

NODE_COUNT_OUT_EDGES_COLUMN_METADATA = NetworkEdgeAttributeMetadata(doc=NODE_COUNT_OUT_EDGES_TEXT, computed_attribute=True) module-attribute

NODE_COUNT_OUT_EDGES_MULTI_COLUMN_METADATA = NetworkEdgeAttributeMetadata(doc=NODE_COUNT_OUT_EDGES_MULTI_TEXT, computed_attribute=True) module-attribute

EDGE_ID_COLUMN_METADATA = NetworkEdgeAttributeMetadata(doc='The unique id for the edge.', computed_attribute=True) module-attribute

EDGE_SOURCE_COLUMN_METADATA = NetworkEdgeAttributeMetadata(doc=EDGE_SOURCE_TEXT, computed_attribute=True) module-attribute

EDGE_TARGET_COLUMN_METADATA = NetworkEdgeAttributeMetadata(doc=EDGE_TARGET_TEXT, computed_attribute=True) module-attribute

EDGE_COUNT_DUP_DIRECTED_COLUMN_METADATA = NetworkEdgeAttributeMetadata(doc=EDGE_COUNT_DUP_DIRECTED_TEXT, computed_attribute=True) module-attribute

EDGE_IDX_DUP_DIRECTED_COLUMN_METADATA = NetworkEdgeAttributeMetadata(doc=EDGE_IDX_DUP_DIRECTED_TEXT, computed_attribute=True) module-attribute

EDGE_COUNT_DUP_UNDIRECTED_COLUMN_METADATA = NetworkEdgeAttributeMetadata(doc=EDGE_COUNT_DUP_UNDIRECTED_TEXT, computed_attribute=True) module-attribute

EDGE_IDX_DUP_UNDIRECTED_COLUMN_METADATA = NetworkEdgeAttributeMetadata(doc=EDGE_IDX_DUP_UNDIRECTED_TEXT, computed_attribute=True) module-attribute

Classes

NetworkNodeAttributeMetadata

Bases: KiaraModel

Source code in src/kiara_plugin/network_analysis/models/metadata.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
class NetworkNodeAttributeMetadata(KiaraModel):
    _kiara_model_id: ClassVar = "metadata.network_node_attribute"

    doc: DocumentationMetadataModel = Field(
        description="Explanation what this attribute is about.",
        default_factory=DocumentationMetadataModel.create,
    )
    computed_attribute: bool = Field(
        description="Whether this is the default attribute that is always automatically added by kiara.",
        default=False,
    )

    @field_validator("doc", mode="before")
    @classmethod
    def validate_doc(cls, value):
        return DocumentationMetadataModel.create(value)

Attributes

doc: DocumentationMetadataModel = Field(description='Explanation what this attribute is about.', default_factory=DocumentationMetadataModel.create) class-attribute instance-attribute
computed_attribute: bool = Field(description='Whether this is the default attribute that is always automatically added by kiara.', default=False) class-attribute instance-attribute

Functions

validate_doc(value) classmethod
Source code in src/kiara_plugin/network_analysis/models/metadata.py 
39
40
41
42
@field_validator("doc", mode="before")
@classmethod
def validate_doc(cls, value):
    return DocumentationMetadataModel.create(value)

NetworkEdgeAttributeMetadata

Bases: KiaraModel

Source code in src/kiara_plugin/network_analysis/models/metadata.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
class NetworkEdgeAttributeMetadata(KiaraModel):
    _kiara_model_id: ClassVar = "metadata.network_edge_attribute"

    doc: DocumentationMetadataModel = Field(
        description="Explanation what this attribute is about.",
        default_factory=DocumentationMetadataModel.create,
    )
    computed_attribute: bool = Field(
        description="Whether this is the computed attribute that is automatically added by kiara.",
        default=False,
    )

    @field_validator("doc", mode="before")
    @classmethod
    def validate_doc(cls, value):
        return DocumentationMetadataModel.create(value)

Attributes

doc: DocumentationMetadataModel = Field(description='Explanation what this attribute is about.', default_factory=DocumentationMetadataModel.create) class-attribute instance-attribute
computed_attribute: bool = Field(description='Whether this is the computed attribute that is automatically added by kiara.', default=False) class-attribute instance-attribute

Functions

validate_doc(value) classmethod
Source code in src/kiara_plugin/network_analysis/models/metadata.py 
57
58
59
60
@field_validator("doc", mode="before")
@classmethod
def validate_doc(cls, value):
    return DocumentationMetadataModel.create(value)