Skip to content

EmbeddingFeature#

[source]

EmbeddingFeature#

hsfs.embedding.EmbeddingFeature(
    name=None,
    dimension=None,
    similarity_function_type="l2_norm",
    feature_group=None,
    embedding_index=None,
)

Represents an embedding feature.

Arguments

  • name Optional[str]: The name of the embedding feature.
  • dimension Optional[int]: The dimensionality of the embedding feature.
  • similarity_function_type hsfs.embedding.SimilarityFunctionType: The type of similarity function used for the embedding feature. Available functions are L2, COSINE, and DOT_PRODUCT. (default is SimilarityFunctionType.L2).
  • feature_group: The feature group object that contains the embedding feature.
  • embedding_index: EmbeddingIndex The index for managing embedding features.

Properties#

[source]

dimenstion#

int: The dimensionality of the embedding feature.


[source]

embedding_index#

EmbeddingIndex: The index for managing embedding features.


[source]

feature_group#

FeatureGroup: The feature group object that contains the embedding feature.


[source]

name#

str: The name of the embedding feature.


[source]

similarity_function_type#

SimilarityFunctionType: The type of similarity function used for the embedding feature.