-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathopendataval.dataval.volume.html
555 lines (513 loc) · 44.6 KB
/
opendataval.dataval.volume.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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
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
<!doctype html>
<html class="no-js" lang="en" data-content_root="./">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="opendataval.dataval.DataEvaluator" href="generated/opendataval.dataval.DataEvaluator.html" /><link rel="prev" title="opendataval.dataval.random package" href="opendataval.dataval.random.html" />
<link rel="shortcut icon" href="_static/favicon.ico"/><!-- Generated with Sphinx 7.2.6 and Furo 2023.09.10 -->
<title>opendataval.dataval.volume package - OpenDataVal documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=36a5483c" />
<style>
body {
--color-code-background: #f8f8f8;
--color-code-foreground: black;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
}
}
</style></head>
<body>
<script>
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
</script>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-toc" viewBox="0 0 24 24">
<title>Contents</title>
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
<line x1="3" y1="12" x2="21" y2="12"></line>
<line x1="3" y1="6" x2="21" y2="6"></line>
<line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-sun" viewBox="0 0 24 24">
<title>Light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
<circle cx="12" cy="12" r="5"></circle>
<line x1="12" y1="1" x2="12" y2="3"></line>
<line x1="12" y1="21" x2="12" y2="23"></line>
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
<line x1="1" y1="12" x2="3" y2="12"></line>
<line x1="21" y1="12" x2="23" y2="12"></line>
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
</svg>
</symbol>
<symbol id="svg-moon" viewBox="0 0 24 24">
<title>Dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
</svg>
</symbol>
<symbol id="svg-sun-half" viewBox="0 0 24 24">
<title>Auto light/dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
<circle cx="12" cy="12" r="9" />
<path d="M13 12h5" />
<path d="M13 15h4" />
<path d="M13 18h1" />
<path d="M13 9h4" />
<path d="M13 6h1" />
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
<label class="overlay sidebar-overlay" for="__navigation">
<div class="visually-hidden">Hide navigation sidebar</div>
</label>
<label class="overlay toc-overlay" for="__toc">
<div class="visually-hidden">Hide table of contents sidebar</div>
</label>
<div class="page">
<header class="mobile-header">
<div class="header-left">
<label class="nav-overlay-icon" for="__navigation">
<div class="visually-hidden">Toggle site navigation sidebar</div>
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">OpenDataVal documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
</header>
<aside class="sidebar-drawer">
<div class="sidebar-container">
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<div class="sidebar-logo-container">
<img class="sidebar-logo only-light" src="_static/logo-light-mode.png" alt="Light Logo"/>
<img class="sidebar-logo only-dark" src="_static/logo-dark-mode.png" alt="Dark Logo"/>
</div>
<span class="sidebar-brand-text">OpenDataVal documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
<ul class="current">
<li class="toctree-l1 current has-children"><a class="reference internal" href="modules.html">modules</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
<li class="toctree-l2 current has-children"><a class="reference internal" href="opendataval.html">opendataval package</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of opendataval package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
<li class="toctree-l3 has-children"><a class="reference internal" href="opendataval.dataloader.html">opendataval.dataloader package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of opendataval.dataloader package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l4 has-children"><a class="reference internal" href="opendataval.dataloader.datasets.html">opendataval.dataloader.datasets package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of opendataval.dataloader.datasets package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l5"><a class="reference internal" href="generated/opendataval.dataloader.datasets.datasets.html">opendataval.dataloader.datasets.datasets</a></li>
<li class="toctree-l5"><a class="reference internal" href="generated/opendataval.dataloader.datasets.imagesets.html">opendataval.dataloader.datasets.imagesets</a></li>
<li class="toctree-l5"><a class="reference internal" href="generated/opendataval.dataloader.datasets.nlpsets.html">opendataval.dataloader.datasets.nlpsets</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataloader.Register.html">opendataval.dataloader.Register</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataloader.DataFetcher.html">opendataval.dataloader.DataFetcher</a></li>
<li class="toctree-l4 has-children"><a class="reference internal" href="generated/opendataval.dataloader.datasets.html">opendataval.dataloader.datasets</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of opendataval.dataloader.datasets</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l5"><a class="reference internal" href="generated/generated/opendataval.dataloader.datasets.datasets.html">opendataval.dataloader.datasets.datasets</a></li>
<li class="toctree-l5"><a class="reference internal" href="generated/generated/opendataval.dataloader.datasets.imagesets.html">opendataval.dataloader.datasets.imagesets</a></li>
<li class="toctree-l5"><a class="reference internal" href="generated/generated/opendataval.dataloader.datasets.nlpsets.html">opendataval.dataloader.datasets.nlpsets</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataloader.cache.html">opendataval.dataloader.cache</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataloader.mix_labels.html">opendataval.dataloader.mix_labels</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataloader.one_hot_encode.html">opendataval.dataloader.one_hot_encode</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataloader.CatDataset.html">opendataval.dataloader.CatDataset</a></li>
</ul>
</li>
<li class="toctree-l3 current has-children"><a class="reference internal" href="opendataval.dataval.html">opendataval.dataval package</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle navigation of opendataval.dataval package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="opendataval.dataval.ame.html">opendataval.dataval.ame package</a></li>
<li class="toctree-l4"><a class="reference internal" href="opendataval.dataval.csshap.html">opendataval.dataval.csshap package</a></li>
<li class="toctree-l4"><a class="reference internal" href="opendataval.dataval.dvrl.html">opendataval.dataval.dvrl package</a></li>
<li class="toctree-l4"><a class="reference internal" href="opendataval.dataval.influence.html">opendataval.dataval.influence package</a></li>
<li class="toctree-l4"><a class="reference internal" href="opendataval.dataval.knnshap.html">opendataval.dataval.knnshap package</a></li>
<li class="toctree-l4"><a class="reference internal" href="opendataval.dataval.lava.html">opendataval.dataval.lava package</a></li>
<li class="toctree-l4"><a class="reference internal" href="opendataval.dataval.margcontrib.html">opendataval.dataval.margcontrib package</a></li>
<li class="toctree-l4"><a class="reference internal" href="opendataval.dataval.oob.html">opendataval.dataval.oob package</a></li>
<li class="toctree-l4"><a class="reference internal" href="opendataval.dataval.random.html">opendataval.dataval.random package</a></li>
<li class="toctree-l4 current current-page"><a class="current reference internal" href="#">opendataval.dataval.volume package</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataval.DataEvaluator.html">opendataval.dataval.DataEvaluator</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataval.ModelMixin.html">opendataval.dataval.ModelMixin</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataval.ModelLessMixin.html">opendataval.dataval.ModelLessMixin</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataval.AME.html">opendataval.dataval.AME</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataval.DVRL.html">opendataval.dataval.DVRL</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataval.InfluenceFunction.html">opendataval.dataval.InfluenceFunction</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataval.InfluenceSubsample.html">opendataval.dataval.InfluenceSubsample</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataval.KNNShapley.html">opendataval.dataval.KNNShapley</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataval.DataOob.html">opendataval.dataval.DataOob</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataval.DataBanzhaf.html">opendataval.dataval.DataBanzhaf</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataval.BetaShapley.html">opendataval.dataval.BetaShapley</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataval.DataShapley.html">opendataval.dataval.DataShapley</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataval.LavaEvaluator.html">opendataval.dataval.LavaEvaluator</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataval.LeaveOneOut.html">opendataval.dataval.LeaveOneOut</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataval.ShapEvaluator.html">opendataval.dataval.ShapEvaluator</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataval.RandomEvaluator.html">opendataval.dataval.RandomEvaluator</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataval.RobustVolumeShapley.html">opendataval.dataval.RobustVolumeShapley</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataval.Sampler.html">opendataval.dataval.Sampler</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataval.TMCSampler.html">opendataval.dataval.TMCSampler</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.dataval.GrTMCSampler.html">opendataval.dataval.GrTMCSampler</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="opendataval.experiment.html">opendataval.experiment package</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><div class="visually-hidden">Toggle navigation of opendataval.experiment package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.experiment.ExperimentMediator.html">opendataval.experiment.ExperimentMediator</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.experiment.exper_methods.html">opendataval.experiment.exper_methods</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="opendataval.model.html">opendataval.model package</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><div class="visually-hidden">Toggle navigation of opendataval.model package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.model.Model.html">opendataval.model.Model</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.model.GradientModel.html">opendataval.model.GradientModel</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.model.ModelFactory.html">opendataval.model.ModelFactory</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.model.TorchClassMixin.html">opendataval.model.TorchClassMixin</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.model.TorchRegressMixin.html">opendataval.model.TorchRegressMixin</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.model.TorchPredictMixin.html">opendataval.model.TorchPredictMixin</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.model.TorchGradMixin.html">opendataval.model.TorchGradMixin</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.model.ClassifierSkLearnWrapper.html">opendataval.model.ClassifierSkLearnWrapper</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.model.ClassifierUnweightedSkLearnWrapper.html">opendataval.model.ClassifierUnweightedSkLearnWrapper</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/opendataval.model.RegressionSkLearnWrapper.html">opendataval.model.RegressionSkLearnWrapper</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="generated/opendataval.dataloader.html">opendataval.dataloader</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle navigation of opendataval.dataloader</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataloader.Register.html">opendataval.dataloader.Register</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataloader.DataFetcher.html">opendataval.dataloader.DataFetcher</a></li>
<li class="toctree-l4 has-children"><a class="reference internal" href="generated/generated/opendataval.dataloader.datasets.html">opendataval.dataloader.datasets</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><div class="visually-hidden">Toggle navigation of opendataval.dataloader.datasets</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l5"><a class="reference internal" href="generated/generated/generated/opendataval.dataloader.datasets.datasets.html">opendataval.dataloader.datasets.datasets</a></li>
<li class="toctree-l5"><a class="reference internal" href="generated/generated/generated/opendataval.dataloader.datasets.imagesets.html">opendataval.dataloader.datasets.imagesets</a></li>
<li class="toctree-l5"><a class="reference internal" href="generated/generated/generated/opendataval.dataloader.datasets.nlpsets.html">opendataval.dataloader.datasets.nlpsets</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataloader.cache.html">opendataval.dataloader.cache</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataloader.mix_labels.html">opendataval.dataloader.mix_labels</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataloader.one_hot_encode.html">opendataval.dataloader.one_hot_encode</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataloader.CatDataset.html">opendataval.dataloader.CatDataset</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="generated/opendataval.dataval.html">opendataval.dataval</a><input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" role="switch" type="checkbox"/><label for="toctree-checkbox-11"><div class="visually-hidden">Toggle navigation of opendataval.dataval</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataval.DataEvaluator.html">opendataval.dataval.DataEvaluator</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataval.ModelMixin.html">opendataval.dataval.ModelMixin</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataval.ModelLessMixin.html">opendataval.dataval.ModelLessMixin</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataval.AME.html">opendataval.dataval.AME</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataval.DVRL.html">opendataval.dataval.DVRL</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataval.InfluenceFunction.html">opendataval.dataval.InfluenceFunction</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataval.InfluenceSubsample.html">opendataval.dataval.InfluenceSubsample</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataval.KNNShapley.html">opendataval.dataval.KNNShapley</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataval.DataOob.html">opendataval.dataval.DataOob</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataval.DataBanzhaf.html">opendataval.dataval.DataBanzhaf</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataval.BetaShapley.html">opendataval.dataval.BetaShapley</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataval.DataShapley.html">opendataval.dataval.DataShapley</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataval.LavaEvaluator.html">opendataval.dataval.LavaEvaluator</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataval.LeaveOneOut.html">opendataval.dataval.LeaveOneOut</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataval.ShapEvaluator.html">opendataval.dataval.ShapEvaluator</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataval.RandomEvaluator.html">opendataval.dataval.RandomEvaluator</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataval.RobustVolumeShapley.html">opendataval.dataval.RobustVolumeShapley</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataval.Sampler.html">opendataval.dataval.Sampler</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataval.TMCSampler.html">opendataval.dataval.TMCSampler</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.dataval.GrTMCSampler.html">opendataval.dataval.GrTMCSampler</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="generated/opendataval.model.html">opendataval.model</a><input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" role="switch" type="checkbox"/><label for="toctree-checkbox-12"><div class="visually-hidden">Toggle navigation of opendataval.model</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.model.Model.html">opendataval.model.Model</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.model.GradientModel.html">opendataval.model.GradientModel</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.model.ModelFactory.html">opendataval.model.ModelFactory</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.model.TorchClassMixin.html">opendataval.model.TorchClassMixin</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.model.TorchRegressMixin.html">opendataval.model.TorchRegressMixin</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.model.TorchPredictMixin.html">opendataval.model.TorchPredictMixin</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.model.TorchGradMixin.html">opendataval.model.TorchGradMixin</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.model.ClassifierSkLearnWrapper.html">opendataval.model.ClassifierSkLearnWrapper</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.model.ClassifierUnweightedSkLearnWrapper.html">opendataval.model.ClassifierUnweightedSkLearnWrapper</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.model.RegressionSkLearnWrapper.html">opendataval.model.RegressionSkLearnWrapper</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="generated/opendataval.experiment.html">opendataval.experiment</a><input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" role="switch" type="checkbox"/><label for="toctree-checkbox-13"><div class="visually-hidden">Toggle navigation of opendataval.experiment</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.experiment.ExperimentMediator.html">opendataval.experiment.ExperimentMediator</a></li>
<li class="toctree-l4"><a class="reference internal" href="generated/generated/opendataval.experiment.exper_methods.html">opendataval.experiment.exper_methods</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="generated/opendataval.util.set_random_state.html">opendataval.util.set_random_state</a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/opendataval.util.load_mediator_output.html">opendataval.util.load_mediator_output</a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/opendataval.__version__.html">opendataval.__version__</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="leaderboards.html">leaderboards</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">license</a></li>
<li class="toctree-l1"><a class="reference internal" href="paper.html">paper</a></li>
</ul>
</div>
</div>
</div>
</div>
</aside>
<div class="main">
<div class="content">
<div class="article-container">
<a href="#" class="back-to-top muted-link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
</svg>
<span>Back to top</span>
</a>
<div class="content-icon-container">
<div class="theme-toggle-container theme-toggle-content">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
<article role="main">
<section id="opendataval-dataval-volume-package">
<h1>opendataval.dataval.volume package<a class="headerlink" href="#opendataval-dataval-volume-package" title="Link to this heading">#</a></h1>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">#</a></h2>
</section>
<section id="module-opendataval.dataval.volume.rvs">
<span id="opendataval-dataval-volume-rvs-module"></span><h2>opendataval.dataval.volume.rvs module<a class="headerlink" href="#module-opendataval.dataval.volume.rvs" title="Link to this heading">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="opendataval.dataval.volume.rvs.RobustVolumeShapley">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">opendataval.dataval.volume.rvs.</span></span><span class="sig-name descname"><span class="pre">RobustVolumeShapley</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#opendataval.dataval.volume.rvs.RobustVolumeShapley" title="Link to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="opendataval.dataval.html#opendataval.dataval.api.DataEvaluator" title="opendataval.dataval.api.DataEvaluator"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataEvaluator</span></code></a>, <a class="reference internal" href="opendataval.dataval.html#opendataval.dataval.api.ModelLessMixin" title="opendataval.dataval.api.ModelLessMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelLessMixin</span></code></a></p>
<p>Robust Volume Shapley and Volume Shapley data valuation implementation.</p>
<p>While the following DataEvaluator uses the same TMC-Shapley algorithm used by
semivalue evaluators, the following implementation defaults to the non-GR statistic
implementation. Instead a fixed number of samples is taken, which is
closer to the original implementation here:
<a class="reference external" href="https://github.com/ZhaoxuanWu/VolumeBased-DataValuation/tree/main">https://github.com/ZhaoxuanWu/VolumeBased-DataValuation/tree/main</a></p>
<section id="references">
<h3>References<a class="headerlink" href="#references" title="Link to this heading">#</a></h3>
<aside class="footnote-list brackets">
<aside class="footnote brackets" id="id1" role="doc-footnote">
<span class="label"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></span>
<p>X. Xu, Z. Wu, C. S. Foo, and B. Kian,
Validation Free and Replication Robust Volume-based Data Valuation,
Advances in Neural Information Processing Systems,
vol. 34, pp. 10837-10848, Dec. 2021.</p>
</aside>
</aside>
</section>
<section id="parameters">
<h3>Parameters<a class="headerlink" href="#parameters" title="Link to this heading">#</a></h3>
<dl class="simple">
<dt>sampler<span class="classifier">Sampler, optional</span></dt><dd><p>Sampler used to compute the marginal contributions. Can be found in
<code class="xref py py-mod docutils literal notranslate"><span class="pre">sampler</span></code>, by default uses <a href="#id2"><span class="problematic" id="id3">*</span></a>args, <a href="#id4"><span class="problematic" id="id5">**</span></a>kwargs for
<a class="reference internal" href="opendataval.dataval.margcontrib.html#opendataval.dataval.margcontrib.sampler.GrTMCSampler" title="opendataval.dataval.margcontrib.sampler.GrTMCSampler"><code class="xref py py-class docutils literal notranslate"><span class="pre">GrTMCSampler</span></code></a>.</p>
</dd>
<dt>robust<span class="classifier">bool, optional</span></dt><dd><p>If the robust volume measure will be used which trades off a “more refined
representation of diversity for greater robustness to replication”,
by default True</p>
</dd>
<dt>omega<span class="classifier">Optional[float], optional</span></dt><dd><p>Width/discretization coefficient for x_train to be split into a set of d-cubes,
required if <cite>robust</cite> is True, by default 0.05</p>
</dd>
</dl>
</section>
<section id="mixins">
<h3>Mixins<a class="headerlink" href="#mixins" title="Link to this heading">#</a></h3>
<dl class="simple">
<dt>ModelLessMixin</dt><dd><p>Mixin for a data evaluator that doesn’t require a model or evaluation metric.</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="opendataval.dataval.volume.rvs.RobustVolumeShapley.evaluate_data_values">
<span class="sig-name descname"><span class="pre">evaluate_data_values</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">ndarray</span></span></span><a class="headerlink" href="#opendataval.dataval.volume.rvs.RobustVolumeShapley.evaluate_data_values" title="Link to this definition">#</a></dt>
<dd><p>Return data values for each training data point.</p>
<section id="returns">
<h4>Returns<a class="headerlink" href="#returns" title="Link to this heading">#</a></h4>
<dl class="simple">
<dt>np.ndarray</dt><dd><p>Predicted data values/selection for training input data point</p>
</dd>
</dl>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="opendataval.dataval.volume.rvs.RobustVolumeShapley.input_data">
<span class="sig-name descname"><span class="pre">input_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x_train</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tensor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_train</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tensor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_valid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tensor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_valid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tensor</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#opendataval.dataval.volume.rvs.RobustVolumeShapley.input_data" title="Link to this definition">#</a></dt>
<dd><p>Store and transform input data for volume-based evaluators.</p>
<section id="id6">
<h4>Parameters<a class="headerlink" href="#id6" title="Link to this heading">#</a></h4>
<dl class="simple">
<dt>x_train<span class="classifier">torch.Tensor</span></dt><dd><p>Data covariates</p>
</dd>
<dt>y_train<span class="classifier">torch.Tensor</span></dt><dd><p>Data labels</p>
</dd>
<dt>x_valid<span class="classifier">torch.Tensor</span></dt><dd><p>Test+Held-out covariates, unused parameter</p>
</dd>
<dt>y_valid<span class="classifier">torch.Tensor</span></dt><dd><p>Test+Held-out labels, unused parameter</p>
</dd>
</dl>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="opendataval.dataval.volume.rvs.RobustVolumeShapley.train_data_values">
<span class="sig-name descname"><span class="pre">train_data_values</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#opendataval.dataval.volume.rvs.RobustVolumeShapley.train_data_values" title="Link to this definition">#</a></dt>
<dd><p>Trains model to predict data values.</p>
<section id="id7">
<h4>Parameters<a class="headerlink" href="#id7" title="Link to this heading">#</a></h4>
<dl class="simple">
<dt>args<span class="classifier">tuple[Any], optional</span></dt><dd><p>Training positional args</p>
</dd>
<dt>kwargs<span class="classifier">dict[str, Any], optional</span></dt><dd><p>Training key word arguments</p>
</dd>
</dl>
</section>
<section id="id8">
<h4>Returns<a class="headerlink" href="#id8" title="Link to this heading">#</a></h4>
<dl class="simple">
<dt>self<span class="classifier">object</span></dt><dd><p>Returns a trained Data Evaluator.</p>
</dd>
</dl>
</section>
</dd></dl>
</section>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="opendataval.dataval.volume.rvs.compute_robust_volumes">
<span class="sig-prename descclassname"><span class="pre">opendataval.dataval.volume.rvs.</span></span><span class="sig-name descname"><span class="pre">compute_robust_volumes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x_tilde</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tensor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hypercubes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#opendataval.dataval.volume.rvs.compute_robust_volumes" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="opendataval.dataval.volume.rvs.compute_x_tilde_and_counts">
<span class="sig-prename descclassname"><span class="pre">opendataval.dataval.volume.rvs.</span></span><span class="sig-name descname"><span class="pre">compute_x_tilde_and_counts</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tensor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">omega</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#opendataval.dataval.volume.rvs.compute_x_tilde_and_counts" title="Link to this definition">#</a></dt>
<dd><p>Compresses the original feature matrix x to x_tilde with the specified omega.</p>
<section id="id9">
<h3>Returns<a class="headerlink" href="#id9" title="Link to this heading">#</a></h3>
<dl class="simple">
<dt>np.ndarray</dt><dd><p>Compressed form of x as a d-cube</p>
</dd>
<dt>dict[tuple, int]</dt><dd><p>A dictionary of cubes with the respective counts in each dcube</p>
</dd>
</dl>
</section>
</dd></dl>
</section>
<section id="module-opendataval.dataval.volume">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-opendataval.dataval.volume" title="Link to this heading">#</a></h2>
</section>
</section>
</article>
</div>
<footer>
<div class="related-pages">
<a class="next-page" href="generated/opendataval.dataval.DataEvaluator.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">opendataval.dataval.DataEvaluator</div>
</div>
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
</a>
<a class="prev-page" href="opendataval.dataval.random.html">
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
<div class="page-info">
<div class="context">
<span>Previous</span>
</div>
<div class="title">opendataval.dataval.random package</div>
</div>
</a>
</div>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright © 2023, OpenDataVal
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo</a>
</div>
<div class="right-details">
</div>
</div>
</footer>
</div>
<aside class="toc-drawer">
<div class="toc-sticky toc-scroll">
<div class="toc-title-container">
<span class="toc-title">
On this page
</span>
</div>
<div class="toc-tree-container">
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">opendataval.dataval.volume package</a><ul>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-opendataval.dataval.volume.rvs">opendataval.dataval.volume.rvs module</a><ul>
<li><a class="reference internal" href="#opendataval.dataval.volume.rvs.RobustVolumeShapley"><code class="docutils literal notranslate"><span class="pre">RobustVolumeShapley</span></code></a><ul>
<li><a class="reference internal" href="#opendataval.dataval.volume.rvs.RobustVolumeShapley.evaluate_data_values"><code class="docutils literal notranslate"><span class="pre">RobustVolumeShapley.evaluate_data_values()</span></code></a></li>
<li><a class="reference internal" href="#opendataval.dataval.volume.rvs.RobustVolumeShapley.input_data"><code class="docutils literal notranslate"><span class="pre">RobustVolumeShapley.input_data()</span></code></a></li>
<li><a class="reference internal" href="#opendataval.dataval.volume.rvs.RobustVolumeShapley.train_data_values"><code class="docutils literal notranslate"><span class="pre">RobustVolumeShapley.train_data_values()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#opendataval.dataval.volume.rvs.compute_robust_volumes"><code class="docutils literal notranslate"><span class="pre">compute_robust_volumes()</span></code></a></li>
<li><a class="reference internal" href="#opendataval.dataval.volume.rvs.compute_x_tilde_and_counts"><code class="docutils literal notranslate"><span class="pre">compute_x_tilde_and_counts()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-opendataval.dataval.volume">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</aside>
</div>
</div><script src="_static/documentation_options.js?v=7f41d439"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/furo.js?v=32e29ea5"></script>
</body>
</html>