meridian.analysis.analyzer.DataTensors.Spec

View source on GitHub

Base class for tf.ExtensionType TypeSpec.

  meridian 
 . 
 analysis 
 . 
 analyzer 
 . 
 DataTensors 
 . 
 Spec 
 ( 
 media 
 , 
 media_spend 
 , 
 reach 
 , 
 frequency 
 , 
 rf_impressions 
 , 
 rf_spend 
 , 
 organic_media 
 , 
 organic_reach 
 , 
 organic_frequency 
 , 
 non_media_treatments 
 , 
 controls 
 , 
 revenue_per_kpi 
 , 
 time 
 ) 
 

Methods

experimental_as_proto

  experimental_as_proto 
 () 
 -> 
 struct_pb2 
 . 
 TypeSpecProto 
 

Returns a proto representation of the TypeSpec instance.

Do NOT override for custom non-TF types.

experimental_from_proto

  @classmethod 
 
  experimental_from_proto 
 ( 
 proto 
 : 
 struct_pb2 
 . 
 TypeSpecProto 
 ) 
 -> 
 'TypeSpec' 
 

Returns a TypeSpec instance based on the serialized proto.

Do NOT override for custom non-TF types.

experimental_type_proto

  @classmethod 
 
  experimental_type_proto 
 () 
 -> 
 Type 
 [ 
 struct_pb2 
 . 
 TypeSpecProto 
 ] 
 

Returns the type of proto associated with TypeSpec serialization.

Do NOT override for custom non-TF types.

from_value

  @classmethod 
 
  from_value 
 ( 
 value 
 ) 
 

is_compatible_with

  is_compatible_with 
 ( 
 spec_or_value 
 ) 
 

Returns true if spec_or_value is compatible with this TypeSpec.

Prefer using "is_subtype_of" and "most_specific_common_supertype" wherever possible.

is_subtype_of

  is_subtype_of 
 ( 
 other 
 : 
 trace 
 . 
 TraceType 
 ) 
 -> 
 bool 
 

Returns True if self is a subtype of other .

Implements the tf.types.experimental.func.TraceType interface.

If not overridden by a subclass, the default behavior is to assume the TypeSpec is covariant upon attributes that implement TraceType and invariant upon rest of the attributes as well as the structure and type of the TypeSpec.

most_specific_common_supertype

  most_specific_common_supertype 
 ( 
 others 
 : 
 Sequence 
 [ 
 trace 
 . 
 TraceType 
 ] 
 ) 
 -> 
 Optional 
 [ 
 'TypeSpec' 
 ] 
 

Returns the most specific supertype TypeSpec of self and others .

Implements the tf.types.experimental.func.TraceType interface.

If not overridden by a subclass, the default behavior is to assume the TypeSpec is covariant upon attributes that implement TraceType and invariant upon rest of the attributes as well as the structure and type of the TypeSpec.

most_specific_compatible_type

  most_specific_compatible_type 
 ( 
 other 
 : 
 'TypeSpec' 
 ) 
 -> 
 'TypeSpec' 
 

Returns the most specific TypeSpec compatible with self and other . (deprecated)

Deprecated. Please use most_specific_common_supertype instead. Do not override this function.

__eq__

  __eq__ 
 ( 
 other 
 ) 
 -> 
 bool 
 

Return self==value.

__ne__

  __ne__ 
 ( 
 other 
 ) 
 -> 
 bool 
 

Return self!=value.