Class that performs dense feature vector extraction on text.
tflite_support
.
task
.
text
.
TextEmbedder
(
options
:
tflite_support
.
task
.
text
.
TextEmbedderOptions
,
cpp_embedder
:
_CppTextEmbedder
)
->
None
Methods
cosine_similarity
cosine_similarity
(
u
:
tflite_support
.
task
.
processor
.
FeatureVector
,
v
:
tflite_support
.
task
.
processor
.
FeatureVector
)
->
float
Computes cosine similarity [1] between two feature vectors.
create_from_file
@classmethodcreate_from_file ( file_path : str ) -> 'TextEmbedder'
Creates the TextEmbedder
object from a TensorFlow Lite model.
Args
file_path
Path to the model.
Returns
TextEmbedder
object that's created from the model file.
Raises
ValueError
If failed to create
TextEmbedder
object from the provided
file such as invalid file.RuntimeError
If other types of error occurred.
create_from_options
@classmethodcreate_from_options ( options :tflite_support . task . text . TextEmbedderOptions) -> 'TextEmbedder'
Creates the TextEmbedder
object from text embedder options.
Args
options
Options for the text embedder task.
Returns
TextEmbedder
object that's created from options
.
Raises
ValueError
If failed to create
TextEmbedder
object from TextEmbedderOptions
such as missing the model.RuntimeError
If other types of error occurred.
embed
embed
(
text
:
str
)
->
tflite_support
.
task
.
processor
.
EmbeddingResult
Performs actual feature vector extraction on the provided text.
Returns
embedding result.
Raises
ValueError
If any of the input arguments is invalid.
RuntimeError
If failed to calculate the embedding vector.
get_embedding_dimension
get_embedding_dimension
(
output_index
:
int
)
->
int
Gets the dimensionality of the embedding output.
Args
output_index
The output index of output layer.
Returns
Dimensionality of the embedding output by the output_index'th output
layer. Returns -1 if
output_index
is out of bounds.