dacapo.experiments.tasks.evaluators.dummy_evaluation_scores

Classes

DummyEvaluationScores

The evaluation scores for the dummy task. The scores include the frizz level and blipp score. A higher frizz level indicates more frizz, while a higher blipp score indicates better performance.

Module Contents

class dacapo.experiments.tasks.evaluators.dummy_evaluation_scores.DummyEvaluationScores

The evaluation scores for the dummy task. The scores include the frizz level and blipp score. A higher frizz level indicates more frizz, while a higher blipp score indicates better performance.

frizz_level: float the frizz level

blipp_score: float the blipp score

higher_is_better(criterion): Return whether higher is better for the given criterion.

bounds(criterion): Return the bounds for the given criterion.

store_best(criterion): Return whether to store the best score for the given criterion.

Note

The DummyEvaluationScores class is used to store the evaluation scores for the dummy task. The class also provides methods to determine whether higher is better for a given criterion, the bounds for a given criterion, and whether to store the best score for a given criterion.

criteria = ['frizz_level', 'blipp_score']

The evaluation criteria.

Returns:

List[str]: the evaluation criteria

Raises:

NotImplementedError – if the function is not implemented

Examples

>>> evaluation_scores = EvaluationScores()
>>> evaluation_scores.criteria
["criterion1", "criterion2"]

Note

This function is used to return the evaluation criteria.

frizz_level: float

blipp_score: float

static higher_is_better(criterion: str) → bool

Return whether higher is better for the given criterion.

Parameters:

criterion – str the evaluation criterion

Returns:

bool: whether higher is better for this criterion

Raises:

NotImplementedError – if the function is not implemented

Examples

>>> DummyEvaluationScores.higher_is_better("frizz_level")
True

Note

This function is used to determine whether higher is better for the given criterion.

static bounds(criterion: str) → Tuple[int | float | None, int | float | None]

Return the bounds for the given criterion.

Parameters:

criterion – str the evaluation criterion

Returns:

Tuple[Union[int, float, None], Union[int, float, None]]: the bounds for the given criterion

Raises:

NotImplementedError – if the function is not implemented

Examples

>>> DummyEvaluationScores.bounds("frizz_level")
(0.0, 1.0)

Note

This function is used to return the bounds for the given criterion.

static store_best(criterion: str) → bool

Return whether to store the best score for the given criterion.

Parameters:

criterion – str the evaluation criterion

Returns:

bool: whether to store the best score for the given criterion

Raises:

NotImplementedError – if the function is not implemented

Examples

>>> DummyEvaluationScores.store_best("frizz_level")
True

Note

This function is used to determine whether to store the best score for the given criterion.