Results

evaldeck.results.GradeResult

Bases: BaseModel

Result from a single grader.

passed property

passed

Check if this grade passed.

passed_result classmethod

passed_result(grader_name, message=None, **kwargs)

Create a passing result.

Source code in src/evaldeck/results.py

@classmethod
def passed_result(
    cls, grader_name: str, message: str | None = None, **kwargs: Any
) -> GradeResult:
    """Create a passing result."""
    return cls(grader_name=grader_name, status=GradeStatus.PASS, message=message, **kwargs)

failed_result classmethod

failed_result(grader_name, message, expected=None, actual=None, **kwargs)

Create a failing result.

Source code in src/evaldeck/results.py

@classmethod
def failed_result(
    cls,
    grader_name: str,
    message: str,
    expected: Any = None,
    actual: Any = None,
    **kwargs: Any,
) -> GradeResult:
    """Create a failing result."""
    return cls(
        grader_name=grader_name,
        status=GradeStatus.FAIL,
        message=message,
        expected=expected,
        actual=actual,
        **kwargs,
    )

error_result classmethod

error_result(grader_name, message, **kwargs)

Create an error result.

Source code in src/evaldeck/results.py

@classmethod
def error_result(cls, grader_name: str, message: str, **kwargs: Any) -> GradeResult:
    """Create an error result."""
    return cls(grader_name=grader_name, status=GradeStatus.ERROR, message=message, **kwargs)

---

evaldeck.results.GradeStatus

Bases: str, Enum

Status of a grading result.

---

evaldeck.results.MetricResult

Bases: BaseModel

Result from a metric calculation.