aligned.exposed_model.sentence_transformer.SentenceTransformerPredictor

class documentation

class SentenceTransformerPredictor(ExposedModel, PromptModel): (source)

View In Hierarchy

Undocumented

Async Method needed_entities Undocumented
Async Method needed_features Undocumented
Async Method potential_drift_from_model Checks if a change in model can lead to a potential distribution shift.
Method prompt_template_hash Undocumented
Async Method run_polars Undocumented
Class Variable embedding_name Undocumented
Class Variable features_to_load Undocumented
Class Variable model_name Undocumented
Class Variable model_type Undocumented
Class Variable precomputed_prompt_key_overwrite Undocumented
Class Variable prompt_template Undocumented
Property as_markdown Undocumented
Property exposed_at_url Undocumented
Property precomputed_prompt_key This is the property that contains the fully compiled prompt. Meaning a user can bypass the prompt templating step.
async def needed_entities(self, store: ModelFeatureStore) -> set[Feature]: (source)

Undocumented

async def needed_features(self, store: ModelFeatureStore) -> list[FeatureReference]: (source)

Undocumented

async def potential_drift_from_model(self, old_model: ExposedModel) -> str | None: (source)

Checks if a change in model can lead to a potential distribution shift.

Returns:
str: A message explaining the potential drift.
def prompt_template_hash(self) -> str: (source)

Undocumented

async def run_polars(self, values: RetrievalJob, store: ModelFeatureStore) -> pl.DataFrame: (source)

Undocumented

embedding_name: str = (source)

Undocumented

features_to_load: list[FeatureReference] = (source)

Undocumented

model_name: str = (source)

Undocumented

model_type: str = (source)

Undocumented

precomputed_prompt_key_overwrite: str = (source)

Undocumented

prompt_template: str = (source)

Undocumented

as_markdown: str = (source)

Undocumented

exposed_at_url: str | None = (source)

Undocumented

precomputed_prompt_key: str | None = (source)
overrides aligned.exposed_model.interface.PromptModel.precomputed_prompt_key

This is the property that contains the fully compiled prompt. Meaning a user can bypass the prompt templating step.

This is useful in some scanarios where we want to do similarity search when the prompt components do not make sense to provide.