pyrit.score.TrueFalseCompositeScorer

pyrit.score.TrueFalseCompositeScorer#

class TrueFalseCompositeScorer(*, aggregator: Callable[[Iterable[Score]], ScoreAggregatorResult], scorers: List[TrueFalseScorer])[source]#

Bases: TrueFalseScorer

Composite true/false scorer that aggregates results from other true/false scorers.

This scorer invokes a collection of constituent TrueFalseScorer instances and reduces their single-score outputs into one final true/false score using the supplied aggregation function (e.g., TrueFalseScoreAggregator.AND, TrueFalseScoreAggregator.OR, TrueFalseScoreAggregator.MAJORITY).

__init__(*, aggregator: Callable[[Iterable[Score]], ScoreAggregatorResult], scorers: List[TrueFalseScorer]) → None[source]#

Initialize the composite scorer.

Parameters:

  • aggregator (TrueFalseAggregatorFunc) – Aggregation function to combine child scores (e.g., TrueFalseScoreAggregator.AND, TrueFalseScoreAggregator.OR, TrueFalseScoreAggregator.MAJORITY).

  • scorers (List[TrueFalseScorer]) – The constituent true/false scorers to invoke.

Raises:

  • ValueError – If no scorers are provided.

  • ValueError – If any provided scorer is not a TrueFalseScorer.

Methods

__init__(*, aggregator, scorers)

Initialize the composite scorer.

get_identifier()

Get an identifier dictionary for the scorer.

get_scorer_metrics(dataset_name[, metrics_type])

Get evaluation statistics for the scorer using the dataset_name of the human labeled dataset.

scale_value_float(value, min_value, max_value)

Scales a value from 0 to 1 based on the given min and max values.

score_async(message, *[, objective, ...])

Score the message, add the results to the database, and return a list of Score objects.

score_image_async(image_path, *[, objective])

Score the given image using the chat target.

score_image_batch_async(*, image_paths[, ...])

Score a batch of images asynchronously.

score_prompts_batch_async(*, messages[, ...])

Score multiple prompts in batches using the provided objectives.

score_response_async(*, response[, ...])

Score a response using an objective scorer and optional auxiliary scorers.

score_response_multiple_scorers_async(*, ...)

Score a response using multiple scorers in parallel.

score_text_async(text, *[, objective])

Scores the given text based on the task using the chat target.

validate_return_scores(scores)

Validate the scores returned by the scorer.

Attributes

scorer_type

scorer_type: ScoreType#
Contents