Introducing LiteRT: Google's high-performance runtime for on-device AI, formerly known as TensorFlow Lite.
Learn more
tflite_support.task.text.TextEmbedder
Stay organized with collections
Save and categorize content based on your preferences.
Class that performs dense feature vector extraction on text.
tflite_support.task.text.TextEmbedder(
options: tflite_support.task.text.TextEmbedderOptions
,
cpp_embedder: _CppTextEmbedder
) -> None
Attributes |
number_of_output_layers
|
Gets the number of output layers of the model.
|
options
|
|
Methods
cosine_similarity
View source
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
View source
@classmethod
create_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
View source
@classmethod
create_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
View source
embed(
text: str
) -> tflite_support.task.processor.EmbeddingResult
Performs actual feature vector extraction on the provided text.
Args |
text
|
the input text, used to extract the feature vectors.
|
Returns |
embedding result.
|
Raises |
ValueError
|
If any of the input arguments is invalid.
|
RuntimeError
|
If failed to calculate the embedding vector.
|
get_embedding_dimension
View source
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-05-08 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Missing the information I need"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Too complicated / too many steps"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Out of date"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Samples / code issue"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
{"lastModified": "Last updated 2024-05-08 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-05-08 UTC."],[],[]]