snapchat.research.gbml.dataset_metadata_pb2#

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

Attributes#

`DESCRIPTOR`
`global___DatasetMetadata`
`global___NodeAnchorBasedLinkPredictionDataset`
`global___SupervisedLinkBasedTaskSplitDataset`
`global___SupervisedNodeClassificationDataset`

Classes#

`DatasetMetadata`	Stores final dataset output by SplitGenerator
`NodeAnchorBasedLinkPredictionDataset`	Stores NodeAnchorBasedLinkPredictionSample-relevant output
`SupervisedLinkBasedTaskSplitDataset`	Stores SupervisedLinkBasedTaskSample-relevant output
`SupervisedNodeClassificationDataset`	Stores SupervisedNodeClassificationSample-relevant output

Module Contents#

class snapchat.research.gbml.dataset_metadata_pb2.DatasetMetadata(*, supervised_node_classification_dataset=..., node_anchor_based_link_prediction_dataset=..., supervised_link_based_task_dataset=...)[source]#

Bases: google.protobuf.message.Message

Stores final dataset output by SplitGenerator

Parameters:

supervised_node_classification_dataset (global___SupervisedNodeClassificationDataset | None)
node_anchor_based_link_prediction_dataset (global___NodeAnchorBasedLinkPredictionDataset | None)
supervised_link_based_task_dataset (global___SupervisedLinkBasedTaskSplitDataset | 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_DATASET_FIELD_NUMBER: int[source]#

SUPERVISED_LINK_BASED_TASK_DATASET_FIELD_NUMBER: int[source]#

SUPERVISED_NODE_CLASSIFICATION_DATASET_FIELD_NUMBER: int[source]#

property node_anchor_based_link_prediction_dataset: global___NodeAnchorBasedLinkPredictionDataset[source]#

indicates the output is of NodeAnchorBasedLinkPredictionSamples

Return type:: global___NodeAnchorBasedLinkPredictionDataset

property supervised_link_based_task_dataset: global___SupervisedLinkBasedTaskSplitDataset[source]#

indicates the output is of SupervisedLinkBasedTaskSamples

Return type:: global___SupervisedLinkBasedTaskSplitDataset

property supervised_node_classification_dataset: global___SupervisedNodeClassificationDataset[source]#

indicates the output is of SupervisedNodeClassificationSamples

Return type:: global___SupervisedNodeClassificationDataset

class snapchat.research.gbml.dataset_metadata_pb2.NodeAnchorBasedLinkPredictionDataset(*, train_main_data_uri=..., test_main_data_uri=..., val_main_data_uri=..., train_node_type_to_random_negative_data_uri=..., val_node_type_to_random_negative_data_uri=..., test_node_type_to_random_negative_data_uri=...)[source]#

Bases: google.protobuf.message.Message

Stores NodeAnchorBasedLinkPredictionSample-relevant output

Parameters:

train_main_data_uri (str)
test_main_data_uri (str)
val_main_data_uri (str)
train_node_type_to_random_negative_data_uri (collections.abc.Mapping[str, str] | None)
val_node_type_to_random_negative_data_uri (collections.abc.Mapping[str, str] | None)
test_node_type_to_random_negative_data_uri (collections.abc.Mapping[str, str] | None)

class TestNodeTypeToRandomNegativeDataUriEntry(*, 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]#

class TrainNodeTypeToRandomNegativeDataUriEntry(*, 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]#

class ValNodeTypeToRandomNegativeDataUriEntry(*, 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]#

TEST_MAIN_DATA_URI_FIELD_NUMBER: int[source]#

TEST_NODE_TYPE_TO_RANDOM_NEGATIVE_DATA_URI_FIELD_NUMBER: int[source]#

TRAIN_MAIN_DATA_URI_FIELD_NUMBER: int[source]#

TRAIN_NODE_TYPE_TO_RANDOM_NEGATIVE_DATA_URI_FIELD_NUMBER: int[source]#

VAL_MAIN_DATA_URI_FIELD_NUMBER: int[source]#

VAL_NODE_TYPE_TO_RANDOM_NEGATIVE_DATA_URI_FIELD_NUMBER: int[source]#

test_main_data_uri: str[source]#

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

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

train_main_data_uri: str[source]#

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

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

val_main_data_uri: str[source]#

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

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

class snapchat.research.gbml.dataset_metadata_pb2.SupervisedLinkBasedTaskSplitDataset(*, train_data_uri=..., test_data_uri=..., val_data_uri=...)[source]#

Bases: google.protobuf.message.Message

Stores SupervisedLinkBasedTaskSample-relevant output

Parameters:

train_data_uri (str)
test_data_uri (str)
val_data_uri (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]#

TEST_DATA_URI_FIELD_NUMBER: int[source]#

TRAIN_DATA_URI_FIELD_NUMBER: int[source]#

VAL_DATA_URI_FIELD_NUMBER: int[source]#

test_data_uri: str[source]#

train_data_uri: str[source]#

val_data_uri: str[source]#

class snapchat.research.gbml.dataset_metadata_pb2.SupervisedNodeClassificationDataset(*, train_data_uri=..., test_data_uri=..., val_data_uri=...)[source]#

Bases: google.protobuf.message.Message

Stores SupervisedNodeClassificationSample-relevant output

Parameters:

train_data_uri (str)
test_data_uri (str)
val_data_uri (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]#

TEST_DATA_URI_FIELD_NUMBER: int[source]#

TRAIN_DATA_URI_FIELD_NUMBER: int[source]#

VAL_DATA_URI_FIELD_NUMBER: int[source]#

test_data_uri: str[source]#

train_data_uri: str[source]#

val_data_uri: str[source]#

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

snapchat.research.gbml.dataset_metadata_pb2.global___DatasetMetadata[source]#

snapchat.research.gbml.dataset_metadata_pb2.global___NodeAnchorBasedLinkPredictionDataset[source]#

snapchat.research.gbml.dataset_metadata_pb2.global___SupervisedLinkBasedTaskSplitDataset[source]#

snapchat.research.gbml.dataset_metadata_pb2.global___SupervisedNodeClassificationDataset[source]#