snapchat.research.gbml.flattened_graph_metadata_pb2#

@generated by mypy-protobuf. Do not edit manually! isort:skip_file

Attributes#

`DESCRIPTOR`
`global___FlattenedGraphMetadata`
`global___NodeAnchorBasedLinkPredictionOutput`
`global___SupervisedLinkBasedTaskOutput`
`global___SupervisedNodeClassificationOutput`

Classes#

`FlattenedGraphMetadata`	Stores flattened graph metadata output by SubgraphSampler
`NodeAnchorBasedLinkPredictionOutput`	Stores NodeAnchorBasedLinkPredictionSample-relevant output
`SupervisedLinkBasedTaskOutput`	Stores SupervisedLinkBasedTaskSample-relevant output
`SupervisedNodeClassificationOutput`	Stores SupervisedNodeClassificationSample-relevant output

Module Contents#

class snapchat.research.gbml.flattened_graph_metadata_pb2.FlattenedGraphMetadata(*, supervised_node_classification_output=..., node_anchor_based_link_prediction_output=..., supervised_link_based_task_output=...)[source]#

Bases: google.protobuf.message.Message

Stores flattened graph metadata output by SubgraphSampler

Parameters:

supervised_node_classification_output (global___SupervisedNodeClassificationOutput | None)
node_anchor_based_link_prediction_output (global___NodeAnchorBasedLinkPredictionOutput | None)
supervised_link_based_task_output (global___SupervisedLinkBasedTaskOutput | None)

ClearField(field_name)[source]#

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]#

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group)[source]#

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]#

NODE_ANCHOR_BASED_LINK_PREDICTION_OUTPUT_FIELD_NUMBER: int[source]#

SUPERVISED_LINK_BASED_TASK_OUTPUT_FIELD_NUMBER: int[source]#

SUPERVISED_NODE_CLASSIFICATION_OUTPUT_FIELD_NUMBER: int[source]#

property node_anchor_based_link_prediction_output: global___NodeAnchorBasedLinkPredictionOutput[source]#

indicates the output is of NodeAnchorBasedLinkPredictionSamples

Return type:: global___NodeAnchorBasedLinkPredictionOutput

property supervised_link_based_task_output: global___SupervisedLinkBasedTaskOutput[source]#

indicates the output is of SupervisedLinkBasedTaskSamples

Return type:: global___SupervisedLinkBasedTaskOutput

property supervised_node_classification_output: global___SupervisedNodeClassificationOutput[source]#

indicates the output is of SupervisedNodeClassificationSamples

Return type:: global___SupervisedNodeClassificationOutput

class snapchat.research.gbml.flattened_graph_metadata_pb2.NodeAnchorBasedLinkPredictionOutput(*, tfrecord_uri_prefix=..., node_type_to_random_negative_tfrecord_uri_prefix=...)[source]#

Bases: google.protobuf.message.Message

Stores NodeAnchorBasedLinkPredictionSample-relevant output

Parameters:

tfrecord_uri_prefix (str)
node_type_to_random_negative_tfrecord_uri_prefix (collections.abc.Mapping[str, str] | None)

class NodeTypeToRandomNegativeTfrecordUriPrefixEntry(*, key=..., value=...)[source]#

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

key (str)
value (str)

ClearField(field_name)[source]#

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]#

KEY_FIELD_NUMBER: int[source]#

VALUE_FIELD_NUMBER: int[source]#

key: str[source]#

value: str[source]#

ClearField(field_name)[source]#

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]#

NODE_TYPE_TO_RANDOM_NEGATIVE_TFRECORD_URI_PREFIX_FIELD_NUMBER: int[source]#

TFRECORD_URI_PREFIX_FIELD_NUMBER: int[source]#

property node_type_to_random_negative_tfrecord_uri_prefix: google.protobuf.internal.containers.ScalarMap[str, str][source]#

Rooted subgraphs for each type of nodes; besides training, also used for inference as these are just subgraphs for each node

Return type:: google.protobuf.internal.containers.ScalarMap[str, str]

tfrecord_uri_prefix: str[source]#: GCS prefix which can be used to glob the TFRecord dataset.

class snapchat.research.gbml.flattened_graph_metadata_pb2.SupervisedLinkBasedTaskOutput(*, labeled_tfrecord_uri_prefix=..., unlabeled_tfrecord_uri_prefix=...)[source]#

Bases: google.protobuf.message.Message

Stores SupervisedLinkBasedTaskSample-relevant output

Parameters:

labeled_tfrecord_uri_prefix (str)
unlabeled_tfrecord_uri_prefix (str)

ClearField(field_name)[source]#

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]#

LABELED_TFRECORD_URI_PREFIX_FIELD_NUMBER: int[source]#

UNLABELED_TFRECORD_URI_PREFIX_FIELD_NUMBER: int[source]#

labeled_tfrecord_uri_prefix: str[source]#: GCS prefix which can be used to glob the TFRecord dataset.

unlabeled_tfrecord_uri_prefix: str[source]#

class snapchat.research.gbml.flattened_graph_metadata_pb2.SupervisedNodeClassificationOutput(*, labeled_tfrecord_uri_prefix=..., unlabeled_tfrecord_uri_prefix=...)[source]#

Bases: google.protobuf.message.Message

Stores SupervisedNodeClassificationSample-relevant output

Parameters:

labeled_tfrecord_uri_prefix (str)
unlabeled_tfrecord_uri_prefix (str)

ClearField(field_name)[source]#

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]#

LABELED_TFRECORD_URI_PREFIX_FIELD_NUMBER: int[source]#

UNLABELED_TFRECORD_URI_PREFIX_FIELD_NUMBER: int[source]#

labeled_tfrecord_uri_prefix: str[source]#: GCS prefix which can be used to glob the TFRecord dataset.

unlabeled_tfrecord_uri_prefix: str[source]#

snapchat.research.gbml.flattened_graph_metadata_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor[source]#

snapchat.research.gbml.flattened_graph_metadata_pb2.global___FlattenedGraphMetadata[source]#

snapchat.research.gbml.flattened_graph_metadata_pb2.global___NodeAnchorBasedLinkPredictionOutput[source]#

snapchat.research.gbml.flattened_graph_metadata_pb2.global___SupervisedLinkBasedTaskOutput[source]#

snapchat.research.gbml.flattened_graph_metadata_pb2.global___SupervisedNodeClassificationOutput[source]#