Files
cs249r_book/mlsysim/docs/api/core.evaluation.qmd
T

53 lines
1.4 KiB
Plaintext

# core.evaluation { #mlsysim.core.evaluation }
`core.evaluation`
## Classes
| Name | Description |
| --- | --- |
| [EvaluationLevel](#mlsysim.core.evaluation.EvaluationLevel) | A single tier in the Hierarchy of Constraints. |
| [SystemEvaluation](#mlsysim.core.evaluation.SystemEvaluation) | The multi-level scorecard for an analytical system evaluation. |
### EvaluationLevel { #mlsysim.core.evaluation.EvaluationLevel }
```python
core.evaluation.EvaluationLevel()
```
A single tier in the Hierarchy of Constraints.
### SystemEvaluation { #mlsysim.core.evaluation.SystemEvaluation }
```python
core.evaluation.SystemEvaluation()
```
The multi-level scorecard for an analytical system evaluation.
Organizes results into the three pedagogical lenses.
#### Methods
| Name | Description |
| --- | --- |
| [scorecard](#mlsysim.core.evaluation.SystemEvaluation.scorecard) | Generates a human-readable summary for students. |
| [to_dict](#mlsysim.core.evaluation.SystemEvaluation.to_dict) | Flattens the evaluation into a single-level dictionary for CSV/DataFrame export. |
##### scorecard { #mlsysim.core.evaluation.SystemEvaluation.scorecard }
```python
core.evaluation.SystemEvaluation.scorecard()
```
Generates a human-readable summary for students.
##### to_dict { #mlsysim.core.evaluation.SystemEvaluation.to_dict }
```python
core.evaluation.SystemEvaluation.to_dict()
```
Flattens the evaluation into a single-level dictionary for CSV/DataFrame export.