|
1 | 1 | from __future__ import annotations |
2 | 2 |
|
| 3 | +import xmltodict |
| 4 | + |
3 | 5 | from .base import EvaluationMeasureAPI, ResourceV1API, ResourceV2API |
4 | 6 |
|
5 | 7 |
|
6 | 8 | class EvaluationMeasureV1API(ResourceV1API, EvaluationMeasureAPI): |
7 | | - """Version 1 API implementation for evaluation measure resources.""" |
| 9 | + """V1 API implementation for evaluation measures. |
| 10 | +
|
| 11 | + Fetches evaluation measures from the v1 XML API endpoint. |
| 12 | + """ |
| 13 | + |
| 14 | + def list(self) -> list[str]: |
| 15 | + """List all evaluation measures available on OpenML. |
| 16 | +
|
| 17 | + Returns |
| 18 | + ------- |
| 19 | + list[str] |
| 20 | + A list of evaluation measure names. |
| 21 | + """ |
| 22 | + path = "evaluationmeasure/list" |
| 23 | + response = self._http.get(path) |
| 24 | + xml_content = response.text |
| 25 | + |
| 26 | + qualities = xmltodict.parse(xml_content, force_list=("oml:measures")) |
| 27 | + # Minimalistic check if the XML is useful |
| 28 | + if "oml:evaluation_measures" not in qualities: |
| 29 | + raise ValueError('Error in return XML, does not contain "oml:evaluation_measures"') |
| 30 | + |
| 31 | + if not isinstance( |
| 32 | + qualities["oml:evaluation_measures"]["oml:measures"][0]["oml:measure"], list |
| 33 | + ): |
| 34 | + raise TypeError('Error in return XML, does not contain "oml:measure" as a list') |
| 35 | + |
| 36 | + return qualities["oml:evaluation_measures"]["oml:measures"][0]["oml:measure"] |
8 | 37 |
|
9 | 38 |
|
10 | 39 | class EvaluationMeasureV2API(ResourceV2API, EvaluationMeasureAPI): |
11 | | - """Version 2 API implementation for evaluation measure resources.""" |
| 40 | + """V2 API implementation for evaluation measures. |
| 41 | +
|
| 42 | + Fetches evaluation measures from the v2 JSON API endpoint. |
| 43 | + """ |
| 44 | + |
| 45 | + def list(self) -> list[str]: |
| 46 | + """List all evaluation measures available on OpenML. |
| 47 | +
|
| 48 | + Returns |
| 49 | + ------- |
| 50 | + list[str] |
| 51 | + A list of evaluation measure names. |
| 52 | + """ |
| 53 | + path = "evaluationmeasure/list" |
| 54 | + response = self._http.get(path) |
| 55 | + data = response.json() |
| 56 | + |
| 57 | + if not isinstance(data, list): |
| 58 | + raise ValueError(f"Expected list, got {type(data)}") |
| 59 | + |
| 60 | + return data |
0 commit comments