snapchat.research.gbml.inference_metadata_pb2#

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

Attributes#

`DESCRIPTOR`
`global___InferenceMetadata`
`global___InferenceOutput`

Classes#

`InferenceMetadata`	Abstract base class for protocol messages.
`InferenceOutput`	Abstract base class for protocol messages.

Module Contents#

class snapchat.research.gbml.inference_metadata_pb2.InferenceMetadata(*, node_type_to_inferencer_output_info_map=...)[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:: node_type_to_inferencer_output_info_map (collections.abc.Mapping[str, global___InferenceOutput] | None)

class NodeTypeToInferencerOutputInfoMapEntry(*, 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 (global___InferenceOutput | 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: str[source]#

property value: global___InferenceOutput[source]#

Return type:: global___InferenceOutput

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_INFERENCER_OUTPUT_INFO_MAP_FIELD_NUMBER: int[source]#

property node_type_to_inferencer_output_info_map: google.protobuf.internal.containers.MessageMap[str, global___InferenceOutput][source]#

Map of node type to outputs from inferencer

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

class snapchat.research.gbml.inference_metadata_pb2.InferenceOutput(*, embeddings_path=..., predictions_path=...)[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:

embeddings_path (str | None)
predictions_path (str | 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['_embeddings_path', b'_embeddings_path']) → Literal['embeddings_path'] | None[source]#

WhichOneof(oneof_group: Literal['_predictions_path', b'_predictions_path']) → Literal['predictions_path'] | 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]#

EMBEDDINGS_PATH_FIELD_NUMBER: int[source]#

PREDICTIONS_PATH_FIELD_NUMBER: int[source]#

embeddings_path: str[source]#: Embeddings from model output

predictions_path: str[source]#: Predictions from model output

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

snapchat.research.gbml.inference_metadata_pb2.global___InferenceMetadata[source]#

snapchat.research.gbml.inference_metadata_pb2.global___InferenceOutput[source]#