Value functions

Frozen-corpus TF-IDF cosine value function.

class nlp_shap.value.tfidf.TfIdfCosineValue

Bases: object

Score generations with cosine similarity of frozen TF-IDF vectors.

property name: str

Return the registered value-function identifier.

fit(corpus: Sequence[GenerationRecord]) → None

Freeze inverse document frequency weights from corpus.

score(base: GenerationResult, candidate: GenerationResult) → float

Return TF-IDF cosine similarity between candidate and base.

Embedding-based value functions.

class nlp_shap.value.embedding.CosineEmbeddingValue(embedding_mode: EmbeddingMode = EmbeddingMode.STATIC, provider: EmbeddingProvider | None = None)

Bases: object

Cosine similarity between static or contextual embeddings (U1/U2).

property name: str

Return the registered value-function identifier.

score(base: GenerationResult, candidate: GenerationResult) → float

Return cosine similarity between embedding vectors.

class nlp_shap.value.embedding.EuclideanEmbeddingValue(embedding_mode: EmbeddingMode = EmbeddingMode.STATIC, provider: EmbeddingProvider | None = None)

Bases: object

Euclidean-derived similarity between embeddings (U4).

property name: str

Return the registered value-function identifier.

score(base: GenerationResult, candidate: GenerationResult) → float

Return 1 / (1 + distance) between embedding vectors.

Logprob-based value function.

class nlp_shap.value.logprob.LogprobValue

Bases: object

Score generations from summed token log probabilities.

property name: str

Return the registered value-function identifier.

score(base: GenerationResult, candidate: GenerationResult) → float

Return utility from candidate logprobs relative to base.