Client
Thin REST client for the OpenML API — Python port of the subset of
org.openml.apiconnector.io.OpenmlConnector that ProcessDataset uses.
Auth: the API key is read from the OPENML_API_KEY environment variable
(Java's connector holds it as a field on the instance; here we read it in the
constructor so the client is explicit about what it's using).
Endpoints (all under base_url, default https://www.openml.org/api/v1/):
* POST /data/features — data_features_upload
* POST /data/qualities — data_qualities_upload
* POST /data/status/update — data_status_update
* GET /data/unprocessed/{engine_id}/{mode} — data_unprocessed
* POST /data/qualities/unprocessed/{engine_id}/{mode}[/feature][/{tag}]
— data_qualities_unprocessed
* GET /data/{did} — data_get
* POST /run/evaluate — run_evaluate_upload
* GET /evaluation/request/{engine_id}/{mode}/{n}[/{k}/{v}] — evaluation_request
Server errors come back as <oml:api_error><oml:code>…</oml:code>
<oml:message>…</oml:message>[<oml:additional_information>…]
</oml:api_error> and are raised as OpenmlApiError(code, message) —
mirrors Java's ApiException so callers can check err.code against the
OpenML status codes (431 = dataset already processed, 441 = features already
uploaded, 542 = no unprocessed datasets remaining, …).
PROD_BASE_URL = 'https://www.openml.org/api/v1/'
module-attribute
TEST_BASE_URL = 'https://test.openml.org/api/v1/'
module-attribute
TEST_DEFAULT_API_KEY = 'normaluser'
module-attribute
OpenmlClient
Stateful REST client — port of the OpenmlConnector methods used by
ProcessDataset. Construct with an explicit api_key or let it fall
back to OPENML_API_KEY; the key is sent as a multipart form field on
POSTs (Java: entity.addPart("api_key", ...)) and as ?api_key= on
GETs (Java: doApiGetRequest).
Source code in src/client.py
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 | |
api_key = resolved
instance-attribute
base_url = base_url if base_url.endswith('/') else base_url + '/'
instance-attribute
__init__(api_key=None, base_url=None, *, test=False)
Source code in src/client.py
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 | |
data_features_upload(features)
Port of OpenmlConnector.dataFeaturesUpload — POST /data/features
with the serialized XML as the description file part. Returns the
did the server echoes back (<oml:data_features_upload><oml:did>).
Source code in src/client.py
149 150 151 152 153 154 155 156 | |
data_get(did)
Port of OpenmlBasicConnector.dataGet — GET /data/{did},
return the oml:data_set_description node. Used by MergeDataset to
fetch the ARFF URL server-side (the description's oml:url is
relative to whatever server this client targets).
Source code in src/client.py
141 142 143 144 145 146 147 | |
data_qualities_unprocessed(engine_id, mode, qualities, *, feature_qualities=False, priority_tag=None)
Port of OpenmlBasicConnector.dataqualitiesUnprocessed — POST
/data/qualities/unprocessed/{engine_id}/{mode} with a comma-joined
qualities field, optional /feature segment and optional
/{priority_tag} suffix. Returns dataset ids missing any of the
listed qualities. As with data_unprocessed, an empty page comes
back as OpenmlApiError whose message contains "No unprocessed".
Source code in src/client.py
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 | |
data_qualities_upload(qualities)
Port of OpenmlConnector.dataQualitiesUpload — POST /data/qualities.
Returns the did the server echoes back.
Source code in src/client.py
158 159 160 161 162 163 164 | |
data_status_update(did, status)
Port of OpenmlBasicConnector.dataStatusUpdate — POST
/data/status/update with data_id + status string parts.
Returns the data_id the server echoes back.
Source code in src/client.py
166 167 168 169 170 171 172 | |
data_unprocessed(engine_id, mode)
Port of OpenmlBasicConnector.dataUnprocessed — GET
/data/unprocessed/{engine_id}/{mode}. Returns the list of dataset
ids needing processing. An empty page comes back as an OpenmlApiError
whose message contains "No unprocessed" (Java catches the same string
in ProcessDataset.fetchUnprocessed).
Source code in src/client.py
174 175 176 177 178 179 180 181 182 183 184 185 | |
evaluation_request(engine_id, mode, num_requests, filters=None)
Port of OpenmlBasicConnector.evaluationRequest — GET
/evaluation/request/{engine_id}/{mode}/{num_requests} followed by
/{key}/{value} for each filter. Returns the list of run ids to
evaluate.
When no runs remain the server returns API error 1013
(NO_UNEVALUATED_RUNS — see ApiErrorMapping), which surfaces here
as OpenmlApiError; callers should catch it to stop the loop.
Source code in src/client.py
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 | |
run_evaluate_upload(run_eval)
Port of OpenmlConnector.runEvaluate — POST /run/evaluate
with the serialized XML as the description file part. Returns the
run_id the server echoes back
(<oml:run_evaluate><oml:run_id>).
Source code in src/client.py
219 220 221 222 223 224 225 226 227 | |