classifier
SNOMED CT classification via snomed-owl-toolkit (ELK reasoner).
Given an RF2 delta ZIP (produced by :mod:ariadne.hierarchy.rf2_exporter)
and a base SNOMED CT International Edition snapshot, this module runs the
ELK OWL EL++ classifier to infer Is a (parent) relationships for the
new extension concepts.
Prerequisites
- Java 17+ installed and on
PATH. - snomed-owl-toolkit executable JAR — download from
https://github.com/IHTSDO/snomed-owl-toolkit/releases and place at the
path specified by
SNOMED_OWL_TOOLKIT_JAR(env var) or pass explicitly. - SNOMED CT International Edition RF2 snapshot — obtain from
https://mlds.ihtsdotools.org/ (free registration, SNOMED Affiliate License).
Set
SNOMED_BASE_RELEASE_ZIPenv var or pass explicitly.
Usage::
from ariadne.hierarchy.classifier import classify_delta, parse_classification_results
results_zip = classify_delta("data/rf2_output/snomed_delta_20260404.zip")
new_is_a, removed = parse_classification_results(results_zip)
classify_delta(delta_zip, base_snomed_zip=None, *, toolkit_jar=None, java_xms='4g', timeout=600, output_dir=None)
Run ELK classification via snomed-owl-toolkit.
This calls the snomed-owl-toolkit's -classify command which:
- Converts the base SNOMED RF2 snapshot + your delta to OWL
- Runs the ELK reasoner to infer Is a relationships
- Produces a
classification-results-*.zipwith the inferred relationship changes
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
delta_zip
|
str | Path
|
Path to the RF2 delta ZIP (from |
required |
base_snomed_zip
|
str | None
|
Path to the SNOMED CT International Edition RF2
snapshot ZIP. Falls back to |
None
|
toolkit_jar
|
str | None
|
Path to the snomed-owl-toolkit executable JAR.
Falls back to |
None
|
java_xms
|
str
|
JVM initial heap size (default |
'4g'
|
timeout
|
int
|
Maximum seconds to wait for classification (default 600). |
600
|
output_dir
|
str | Path | None
|
Directory where the results ZIP will be written. Defaults to the parent directory of delta_zip. |
None
|
Returns:
| Type | Description |
|---|---|
Path
|
Path to the classification results ZIP. |
Raises:
| Type | Description |
|---|---|
RuntimeError
|
If the classification process fails. |
FileNotFoundError
|
If the toolkit JAR or base release cannot be found. |
TimeoutExpired
|
If classification exceeds timeout. |
Source code in src/ariadne/hierarchy/classifier.py
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 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 | |
parse_classification_results(results_zip)
Parse the classification results ZIP into DataFrames.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
results_zip
|
str | Path
|
Path to the |
required |
Returns:
| Type | Description |
|---|---|
DataFrame
|
|
DataFrame
|
|
DataFrame
|
|
tuple[DataFrame, DataFrame, DataFrame]
|
|
Source code in src/ariadne/hierarchy/classifier.py
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 | |
pre_classification_checks(delta_zip, hierarchy_settings)
Run lightweight structural checks on an RF2 delta ZIP.
Validates:
- The ZIP contains the expected Terminology files
- StatedRelationship file has correct TSV headers
- All destinationId values look like valid SCTIDs (6+ digit integers)
- All typeId values are "Is a" or an attribute configured in hierarchy.attributes
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
delta_zip
|
str | Path
|
Path to the RF2 delta ZIP. |
required |
hierarchy_settings
|
HierarchySettings
|
|
required |
Returns:
| Type | Description |
|---|---|
list[str]
|
List of issue descriptions. Empty list means all checks passed. |
Source code in src/ariadne/hierarchy/classifier.py
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 | |