snapchat.research.gbml.preprocessed_metadata_pb2#

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

Attributes#

`DESCRIPTOR`
`global___PreprocessedMetadata`

Classes#

PreprocessedMetadata

Abstract base class for protocol messages.

Module Contents#

class snapchat.research.gbml.preprocessed_metadata_pb2.PreprocessedMetadata(*, condensed_node_type_to_preprocessed_metadata=..., condensed_edge_type_to_preprocessed_metadata=...)[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:

condensed_node_type_to_preprocessed_metadata (collections.abc.Mapping[int, global___PreprocessedMetadata] | None)
condensed_edge_type_to_preprocessed_metadata (collections.abc.Mapping[int, global___PreprocessedMetadata] | None)

class CondensedEdgeTypeToPreprocessedMetadataEntry(*, 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 (int)
value (global___PreprocessedMetadata | 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.

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

KEY_FIELD_NUMBER: int[source]#

VALUE_FIELD_NUMBER: int[source]#

key: int[source]#

property value: global___PreprocessedMetadata[source]#

Return type:: global___PreprocessedMetadata

class CondensedNodeTypeToPreprocessedMetadataEntry(*, 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 (int)
value (global___PreprocessedMetadata | 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.

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

KEY_FIELD_NUMBER: int[source]#

VALUE_FIELD_NUMBER: int[source]#

key: int[source]#

property value: global___PreprocessedMetadata[source]#

Return type:: global___PreprocessedMetadata

class EdgeMetadataInfo(*, feature_keys=..., label_keys=..., tfrecord_uri_prefix=..., schema_uri=..., enumerated_edge_data_bq_table=..., feature_dim=..., transform_fn_assets_uri=...)[source]#

Bases: google.protobuf.message.Message

Houses metadata of edge features output from DataPreprocessor

Parameters:

feature_keys (collections.abc.Iterable[str] | None)
label_keys (collections.abc.Iterable[str] | None)
tfrecord_uri_prefix (str)
schema_uri (str)
enumerated_edge_data_bq_table (str)
feature_dim (int | None)
transform_fn_assets_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

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]#

ENUMERATED_EDGE_DATA_BQ_TABLE_FIELD_NUMBER: int[source]#

FEATURE_DIM_FIELD_NUMBER: int[source]#

FEATURE_KEYS_FIELD_NUMBER: int[source]#

LABEL_KEYS_FIELD_NUMBER: int[source]#

SCHEMA_URI_FIELD_NUMBER: int[source]#

TFRECORD_URI_PREFIX_FIELD_NUMBER: int[source]#

TRANSFORM_FN_ASSETS_URI_FIELD_NUMBER: int[source]#

enumerated_edge_data_bq_table: str[source]#: BQ path to a table which stores the enumerated node id to node metadata association.

feature_dim: int[source]#: Feature dimension after preprocessing

property feature_keys: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str][source]#

Fields in output TFRecords which reference features.

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

property label_keys: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str][source]#

Fields in output TFRecords which reference labels.

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

schema_uri: str[source]#: GCS path to a schema which can be used to parse the TFRecord dataset.

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

transform_fn_assets_uri: str[source]#: Contains categorical feature vocabularies

class EdgeMetadataOutput(*, src_node_id_key=..., dst_node_id_key=..., main_edge_info=..., positive_edge_info=..., negative_edge_info=...)[source]#

Bases: google.protobuf.message.Message

Houses metadata about edge TFTransform output from DataPreprocessor.

Parameters:

src_node_id_key (str)
dst_node_id_key (str)
main_edge_info (global___PreprocessedMetadata | None)
positive_edge_info (global___PreprocessedMetadata | None)
negative_edge_info (global___PreprocessedMetadata | 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: Literal['_negative_edge_info', b'_negative_edge_info']) → Literal['negative_edge_info'] | None[source]#

WhichOneof(oneof_group: Literal['_positive_edge_info', b'_positive_edge_info']) → Literal['positive_edge_info'] | None

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]#

DST_NODE_ID_KEY_FIELD_NUMBER: int[source]#

MAIN_EDGE_INFO_FIELD_NUMBER: int[source]#

NEGATIVE_EDGE_INFO_FIELD_NUMBER: int[source]#

POSITIVE_EDGE_INFO_FIELD_NUMBER: int[source]#

SRC_NODE_ID_KEY_FIELD_NUMBER: int[source]#

dst_node_id_key: str[source]#: The field in output TFRecords which references the destination node identifier.

property main_edge_info: global___PreprocessedMetadata[source]#

Detailed metadata for message-passing edges

Return type:: global___PreprocessedMetadata

property negative_edge_info: global___PreprocessedMetadata[source]#

Detailed metadata for user-defined negative edges

Return type:: global___PreprocessedMetadata

property positive_edge_info: global___PreprocessedMetadata[source]#

Detailed metadata for user-defined positive edges

Return type:: global___PreprocessedMetadata

src_node_id_key: str[source]#: The field in output TFRecords which references the source node identifier.

class NodeMetadataOutput(*, node_id_key=..., feature_keys=..., label_keys=..., tfrecord_uri_prefix=..., schema_uri=..., enumerated_node_ids_bq_table=..., enumerated_node_data_bq_table=..., feature_dim=..., transform_fn_assets_uri=...)[source]#

Bases: google.protobuf.message.Message

Houses metadata about node TFTransform output from DataPreprocessor.

Parameters:

node_id_key (str)
feature_keys (collections.abc.Iterable[str] | None)
label_keys (collections.abc.Iterable[str] | None)
tfrecord_uri_prefix (str)
schema_uri (str)
enumerated_node_ids_bq_table (str)
enumerated_node_data_bq_table (str)
feature_dim (int | None)
transform_fn_assets_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

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]#

ENUMERATED_NODE_DATA_BQ_TABLE_FIELD_NUMBER: int[source]#

ENUMERATED_NODE_IDS_BQ_TABLE_FIELD_NUMBER: int[source]#

FEATURE_DIM_FIELD_NUMBER: int[source]#

FEATURE_KEYS_FIELD_NUMBER: int[source]#

LABEL_KEYS_FIELD_NUMBER: int[source]#

NODE_ID_KEY_FIELD_NUMBER: int[source]#

SCHEMA_URI_FIELD_NUMBER: int[source]#

TFRECORD_URI_PREFIX_FIELD_NUMBER: int[source]#

TRANSFORM_FN_ASSETS_URI_FIELD_NUMBER: int[source]#

enumerated_node_data_bq_table: str[source]#: BQ path to a table which stores the enumerated node id to node metadata association.

enumerated_node_ids_bq_table: str[source]#: BQ path to a table which stores the original to enumerated node id association.

feature_dim: int[source]#: Feature dimension after preprocessing

property feature_keys: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str][source]#

Fields in output TFRecords which reference features.

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

property label_keys: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str][source]#

Fields in output TFRecords which reference labels.

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

node_id_key: str[source]#: The field in output TFRecords which references the node identifier.

schema_uri: str[source]#: GCS path to a schema which can be used to parse the TFRecord dataset.

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

transform_fn_assets_uri: str[source]#: Contains categorical feature vocabularies

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

CONDENSED_EDGE_TYPE_TO_PREPROCESSED_METADATA_FIELD_NUMBER: int[source]#

CONDENSED_NODE_TYPE_TO_PREPROCESSED_METADATA_FIELD_NUMBER: int[source]#

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

property condensed_edge_type_to_preprocessed_metadata: google.protobuf.internal.containers.MessageMap[int, global___PreprocessedMetadata][source]#

Maps condensed edge types to their respective post-TFTransform outputs.

Return type:: google.protobuf.internal.containers.MessageMap[int, global___PreprocessedMetadata]

property condensed_node_type_to_preprocessed_metadata: google.protobuf.internal.containers.MessageMap[int, global___PreprocessedMetadata][source]#

Maps condensed node types to their respective post-TFTransform outputs.

Return type:: google.protobuf.internal.containers.MessageMap[int, global___PreprocessedMetadata]

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

snapchat.research.gbml.preprocessed_metadata_pb2.global___PreprocessedMetadata[source]#