tf.SparseTensorSpec

Type specification for a tf.sparse.SparseTensor.

Inherits From: TypeSpec, TraceType

shapeThe dense shape of the SparseTensor, or None to allow any dense shape.
dtypetf.DType of values in the SparseTensor.

dtypeThe tf.dtypes.DType specified by this type for the SparseTensor.
shapeThe tf.TensorShape specified by this type for the SparseTensor.
value_type

Methods

experimental_as_proto

View source

Returns a proto representation of the TypeSpec instance.

Do NOT override for custom non-TF types.

experimental_from_proto

View source

Returns a TypeSpec instance based on the serialized proto.

Do NOT override for custom non-TF types.

Args
protoProto generated using 'experimental_as_proto'.

experimental_type_proto

View source

Returns the type of proto associated with TypeSpec serialization.

Do NOT override for custom non-TF types.

from_value

View source

is_compatible_with

View source

Returns true if spec_or_value is compatible with this TypeSpec.

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

Args
spec_or_valueA TypeSpec or TypeSpec associated value to compare against.

is_subtype_of

View source

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.

Args
otherA TraceType object.

most_specific_common_supertype

View source

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.

Args
othersA sequence of TraceTypes.

most_specific_compatible_type

View source

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

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

Args
otherA TypeSpec.

Raises
ValueErrorIf there is no TypeSpec that is compatible with both self and other.

__eq__

View source

Return self==value.

__ne__

View source

Return self!=value.