Source code for bluesky_adaptive.evaluation

"""Helpers for building evaluation functions."""

import functools
from collections.abc import Callable, Mapping, Sequence
from typing import Any, TypeVar

from ..protocols import ID_KEY, EvaluationFunction, TUid

_TData = TypeVar("_TData")


[docs] def per_suggestion( evaluate: Callable[[_TData], Mapping[str, Any]], fetch: Callable[[TUid], Mapping[Any, _TData]], ) -> EvaluationFunction[TUid]: """Build an evaluation function from a function of one suggestion's data. The evaluation function applies ``evaluate`` to each value of ``fetch(uid)`` and sets the outcome's ``"_id"`` to its key. Parameters ---------- evaluate : Callable[[_TData], Mapping[str, Any]] Returns the outcome of one suggestion's data. fetch : Callable[[TUid], Mapping[Any, _TData]] Returns each suggestion's data keyed by suggestion ID, e.g. :meth:`RunEventBuffer.pop <bluesky_adaptive.evaluation.documents.RunEventBuffer.pop>`. Returns ------- EvaluationFunction[TUid] The evaluation function. Examples -------- >>> from bluesky_adaptive.evaluation import per_suggestion >>> def score(data): ... return {"objective": 10 * data["x"]} >>> evaluation_function = per_suggestion(score, lambda uid: {"a": {"x": 1.0}, "b": {"x": 2.0}}) >>> evaluation_function("run-uid", []) [{'objective': 10.0, '_id': 'a'}, {'objective': 20.0, '_id': 'b'}] """ @functools.wraps(evaluate) def evaluation_function(uid: TUid, suggestions: Sequence[Mapping]) -> list[dict[str, Any]]: return [{**evaluate(data), ID_KEY: suggestion_id} for suggestion_id, data in fetch(uid).items()] return evaluation_function