Classifiers¶
online_cp.classifiers.ConformalNearestNeighboursClassifier
¶
Bases: ConformalClassifier
Conformal \(k\)-nearest-neighbours classifier ([ALRW2 §2.3]).
The nonconformity measure of a labelled example is the ratio
aggregated by mean or median. An example is nonconforming (large score) when it sits far from its own class but close to another — exactly the 1-NN measure of [ALRW2 §2.3] generalised to \(k\) neighbours. Under exchangeability the prediction sets are valid at every \(\epsilon\).
cp = ConformalNearestNeighboursClassifier(k=1, label_space=[-1, 1], rnd_state=1337, epsilon=0.1) Gamma, p_values = cp.predict(3, return_p_values=True) Gamma # predict both labels, as this is the first array([-1, 1]) tuple(round(p_values[i], 4) for i in (-1, 1)) (0.8781, 0.8781)
cp.learn_one(np.int64(3), 1)
Gamma, p_values = cp.predict(-2, return_p_values=True) Gamma # predict both labels, as this is the first array([-1, 1]) tuple(round(p_values[i], 4) for i in (-1, 1)) (0.1855, 0.1855)
Source code in src/online_cp/classifiers.py
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 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 305 306 307 308 309 310 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 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 | |
__init__(k=1, label_space=None, distance='euclidean', distance_func=None, aggregation='mean', verbose=0, rnd_state=None, n_jobs=None, epsilon=default_epsilon)
¶
Create a conformal nearest-neighbours classifier.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
k
|
int
|
Number of nearest neighbours used in the nonconformity ratio. |
1
|
label_space
|
array - like or None
|
The set of possible labels. If None, it is inferred (and grows) from the data seen so far. |
None
|
distance
|
str
|
Distance metric passed to |
"euclidean"
|
distance_func
|
callable
|
Custom distance |
None
|
aggregation
|
('mean', 'median')
|
How to aggregate the k nearest same/different-class distances. |
"mean"
|
verbose
|
int
|
Verbosity level. |
0
|
rnd_state
|
int, np.random.Generator, or None
|
Seed or Generator for the smoothing-variable generator. |
None
|
n_jobs
|
int or None
|
Number of parallel jobs for per-label p-value computation in
:meth: |
None
|
epsilon
|
float
|
Default significance level. |
0.1
|
Source code in src/online_cp/classifiers.py
learn_initial_training_set(X, y)
¶
Batch-learn an initial training set.
Stores the objects/labels, precomputes the pairwise distance matrix,
and indexes examples by label. Updates the inferred label space unless
a fixed label_space was supplied.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
X
|
ndarray of shape (n, d)
|
Training objects. |
required |
y
|
ndarray of shape (n,)
|
Training labels. |
required |
Source code in src/online_cp/classifiers.py
learn_one(x: NDArray[np.floating[Any]], y: Any, precomputed: NDArray[np.floating[Any]] | None = None) -> None
¶
Update the classifier with a single new example.
Appends (x, y) to the stored data, extends the distance matrix and
label index, and grows the label space if needed.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x
|
ndarray of shape (d,)
|
New object. |
required |
y
|
hashable
|
Observed label. |
required |
precomputed
|
ndarray or None
|
A pre-extended distance matrix (e.g. from a previous
:meth: |
None
|
Source code in src/online_cp/classifiers.py
compute_p_value(x: NDArray[np.floating[Any]], y: Any, return_update: bool = False) -> float | tuple[float, NDArray[np.floating[Any]] | None]
¶
Compute conformal p-value for a single (x, y) pair.
Only tests the given label y (not the full label space), making this faster than predict() when only one p-value is needed.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x
|
array - like
|
Test object. |
required |
y
|
scalar
|
Hypothesized label. |
required |
return_update
|
bool
|
If True, also return the updated distance matrix D. |
False
|
Returns:
| Name | Type | Description |
|---|---|---|
p_value |
float
|
Smoothed conformal p-value for the hypothesis that x has label y. |
D |
(ndarray, optional)
|
Updated distance matrix (only if return_update=True). |
Source code in src/online_cp/classifiers.py
predict(x: NDArray[np.floating[Any]], epsilon: float | NDArray[np.floating[Any]] | None = None, return_p_values: bool = False, return_update: bool = False, verbose: int = 0) -> ConformalPredictionSet | MultiLevelPredictionSet
¶
Compute the conformal prediction set for object x.
For every candidate label the nonconformity ratio is evaluated as if
x carried that label, and the label is kept when its conformal
p-value exceeds epsilon.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x
|
ndarray of shape (d,)
|
Test object. |
required |
epsilon
|
float, array-like, or None
|
Significance level(s). If None, uses |
None
|
return_p_values
|
bool
|
If True, also return the |
False
|
return_update
|
bool
|
If True, also return the extended distance matrix to reuse in a
subsequent :meth: |
False
|
verbose
|
int
|
Verbosity level. |
0
|
Returns:
| Type | Description |
|---|---|
ConformalPredictionSet or MultiLevelPredictionSet, optionally followed
|
|
by the p-value dict and/or the updated distance matrix.
|
|
Source code in src/online_cp/classifiers.py
527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 | |
online_cp.classifiers.ConformalSupportVectorMachine
¶
Bases: ConformalClassifier
Conformal classifier using the Support Vector Machine.
For each candidate label, one-vs-rest binarization is applied and the
SVM dual is solved on the augmented training set. Two nonconformity
measures (NCMs) are available via the nonconformity parameter:
'margin' (default) — signed-margin NCM:
ncm_i = -(y_i · f(x_i)) where f(x) = K·(α·y) + b.
Negative for well-classified examples (conforming), positive for
misclassified ones (nonconforming). Produces a continuous score
with no ties, giving tighter prediction sets on noisy data.
'alpha' — Lagrange-multiplier NCM (ALRW Ch. 3):
ncm_i = α_i. α_i = 0 means well inside the margin
(conforming); α_i = C means misclassified (maximally
nonconforming). Discrete score with many ties at 0 on
well-separated data.
Both measures are valid (coverage-guaranteed). 'margin' is
generally more efficient (smaller prediction sets) when classes
overlap; 'alpha' can be preferable on small, cleanly separable
problems.
Supports multi-class classification via one-vs-rest decomposition. The Gram matrix is label-independent and reused across all candidate labels.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
kernel
|
Kernel, callable, or str
|
|
'rbf'
|
C
|
float
|
Regularization parameter (upper bound on alpha_i). Default 1.0. |
1.0
|
nonconformity
|
str
|
Nonconformity measure: |
'margin'
|
label_space
|
array - like or None
|
The set of possible labels. Supports any number of classes. If None, inferred from the first training data. |
None
|
sigma
|
float
|
Bandwidth for RBF kernel when kernel='rbf'. Default 1.0. |
1.0
|
degree
|
int
|
Degree for polynomial kernel when kernel='poly'. Default 3. |
3
|
coef0
|
float
|
Constant for polynomial kernel. Default 1.0. |
1.0
|
smo_tol
|
float
|
Tolerance for SMO convergence. Default 1e-3. |
0.001
|
smo_max_iter
|
int
|
Maximum SMO iterations. Default 5000. |
5000
|
epsilon
|
float
|
Significance level. Default 0.1. |
default_epsilon
|
rnd_state
|
int, np.random.Generator, or None
|
Random seed or Generator. |
None
|
Examples:
>>> import numpy as np
>>> np.random.seed(42)
>>> X = np.vstack([np.random.normal(loc=-1, size=(20, 2)), np.random.normal(loc=1, size=(20, 2))])
>>> y = np.array([-1] * 20 + [1] * 20)
>>> svm = ConformalSupportVectorMachine(kernel="rbf", sigma=1.0, C=10.0)
>>> svm.learn_initial_training_set(X[:30], y[:30])
>>> Gamma = svm.predict(X[30])
>>> y[30] in Gamma
True
Source code in src/online_cp/classifiers.py
978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 | |
learn_initial_training_set(X: NDArray[np.floating[Any]], y: NDArray[Any]) -> None
¶
Store training data and precompute Gram matrix.
Source code in src/online_cp/classifiers.py
learn_one(x: NDArray[np.floating[Any]], y: Any) -> None
¶
Learn a new example, updating stored data and Gram matrix.
Source code in src/online_cp/classifiers.py
predict(x: NDArray[np.floating[Any]], epsilon: float | NDArray[np.floating[Any]] | None = None, return_p_values: bool = False) -> ConformalPredictionSet | MultiLevelPredictionSet
¶
Compute the conformal prediction set for object x.
For each candidate label the training set is augmented with
(x, label), one-vs-rest binarised, and the SVM dual is solved on the
shared (label-independent) Gram matrix. The configured nonconformity
measure (signed margin or \(\alpha_i\)) then yields a conformal p-value
per label; labels with p-value above epsilon form the set.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x
|
ndarray of shape (d,)
|
Test object. |
required |
epsilon
|
float, array-like, or None
|
Significance level(s). If None, uses |
None
|
return_p_values
|
bool
|
If True, also return the |
False
|
Returns:
| Type | Description |
|---|---|
ConformalPredictionSet or MultiLevelPredictionSet, optionally with the
|
|
p-value dict.
|
|
Source code in src/online_cp/classifiers.py
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 | |
compute_p_value(x, y)
¶
Compute the conformal p-value for (x, y) given current training set.