Evaluation session

The object yielded by ExperimentStore.evaluation(...). It binds an evaluation_id so the record writers inside the context block never have to pass one, and forwards each call to the matching ExperimentStore method.

research_tracker.evaluation_session.EvaluationSession

Source code in src/research_tracker/evaluation_session.py

class EvaluationSession:
    def __init__(
        self,
        store: ExperimentStore,
        evaluation: Evaluation,
    ):
        self.store = store
        self.evaluation = evaluation

    @property
    def evaluation_id(self) -> str:
        return self.evaluation.evaluation_id

    def add_condition(
        self,
        name: str,
        value: str | float | bool,
        *,
        unit: str | None = None,
    ) -> None:
        return self.store.add_condition(
            evaluation_id=self.evaluation_id,
            name=name,
            value=value,
            unit=unit,
        )

    def log_metric(
        self,
        metric: str,
        value: float,
        *,
        sample_id: str | None = None,
        target: str | None = None,
        comparison: str | None = None,
        region: str | None = None,
        unit: str | None = None,
    ) -> None:
        return self.store.log_metric(
            evaluation_id=self.evaluation_id,
            sample_id=sample_id,
            target=target,
            metric=metric,
            value=value,
            comparison=comparison,
            region=region,
            unit=unit,
        )

    def log_artifact(
        self,
        kind: str,
        path: Path,
        *,
        sample_id: str | None = None,
    ) -> None:
        return self.store.log_artifact(
            evaluation_id=self.evaluation_id,
            kind=kind,
            path=path,
            sample_id=sample_id,
        )