A loose federation of distributed, typed datasets
1<!DOCTYPE html>
2<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
3
4<meta charset="utf-8">
5<meta name="generator" content="quarto-1.7.34">
6
7<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
8
9
10<title>datasetdict – atdata</title>
11<style>
12code{white-space: pre-wrap;}
13span.smallcaps{font-variant: small-caps;}
14div.columns{display: flex; gap: min(4vw, 1.5em);}
15div.column{flex: auto; overflow-x: auto;}
16div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
17ul.task-list{list-style: none;}
18ul.task-list li input[type="checkbox"] {
19 width: 0.8em;
20 margin: 0 0.8em 0.2em -1em; /* quarto-specific, see https://github.com/quarto-dev/quarto-cli/issues/4556 */
21 vertical-align: middle;
22}
23/* CSS for syntax highlighting */
24html { -webkit-text-size-adjust: 100%; }
25pre > code.sourceCode { white-space: pre; position: relative; }
26pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
27pre > code.sourceCode > span:empty { height: 1.2em; }
28.sourceCode { overflow: visible; }
29code.sourceCode > span { color: inherit; text-decoration: inherit; }
30div.sourceCode { margin: 1em 0; }
31pre.sourceCode { margin: 0; }
32@media screen {
33div.sourceCode { overflow: auto; }
34}
35@media print {
36pre > code.sourceCode { white-space: pre-wrap; }
37pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
38}
39pre.numberSource code
40 { counter-reset: source-line 0; }
41pre.numberSource code > span
42 { position: relative; left: -4em; counter-increment: source-line; }
43pre.numberSource code > span > a:first-child::before
44 { content: counter(source-line);
45 position: relative; left: -1em; text-align: right; vertical-align: baseline;
46 border: none; display: inline-block;
47 -webkit-touch-callout: none; -webkit-user-select: none;
48 -khtml-user-select: none; -moz-user-select: none;
49 -ms-user-select: none; user-select: none;
50 padding: 0 4px; width: 4em;
51 }
52pre.numberSource { margin-left: 3em; padding-left: 4px; }
53div.sourceCode
54 { }
55@media screen {
56pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
57}
58</style>
59
60
61<script src="../site_libs/quarto-nav/quarto-nav.js"></script>
62<script src="../site_libs/quarto-nav/headroom.min.js"></script>
63<script src="../site_libs/clipboard/clipboard.min.js"></script>
64<script src="../site_libs/quarto-search/autocomplete.umd.js"></script>
65<script src="../site_libs/quarto-search/fuse.min.js"></script>
66<script src="../site_libs/quarto-search/quarto-search.js"></script>
67<meta name="quarto:offset" content="../">
68<script src="../site_libs/quarto-html/quarto.js" type="module"></script>
69<script src="../site_libs/quarto-html/tabsets/tabsets.js" type="module"></script>
70<script src="../site_libs/quarto-html/popper.min.js"></script>
71<script src="../site_libs/quarto-html/tippy.umd.min.js"></script>
72<script src="../site_libs/quarto-html/anchor.min.js"></script>
73<link href="../site_libs/quarto-html/tippy.css" rel="stylesheet">
74<link href="../site_libs/quarto-html/quarto-syntax-highlighting-9582434199d49cc9e91654cdeeb4866b.css" rel="stylesheet" class="quarto-color-scheme" id="quarto-text-highlighting-styles">
75<link href="../site_libs/quarto-html/quarto-syntax-highlighting-dark-8dcd8563ea6803ab7cbb3d71ca5772e1.css" rel="stylesheet" class="quarto-color-scheme quarto-color-alternate" id="quarto-text-highlighting-styles">
76<link href="../site_libs/quarto-html/quarto-syntax-highlighting-9582434199d49cc9e91654cdeeb4866b.css" rel="stylesheet" class="quarto-color-scheme-extra" id="quarto-text-highlighting-styles">
77<script src="../site_libs/bootstrap/bootstrap.min.js"></script>
78<link href="../site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
79<link href="../site_libs/bootstrap/bootstrap-62bce24ca844314e7bb1a34dbdfe05cc.min.css" rel="stylesheet" append-hash="true" class="quarto-color-scheme" id="quarto-bootstrap" data-mode="light">
80<link href="../site_libs/bootstrap/bootstrap-dark-7964ffd8887b0991fe8d71c6c8bc75d6.min.css" rel="stylesheet" append-hash="true" class="quarto-color-scheme quarto-color-alternate" id="quarto-bootstrap" data-mode="dark">
81<link href="../site_libs/bootstrap/bootstrap-62bce24ca844314e7bb1a34dbdfe05cc.min.css" rel="stylesheet" append-hash="true" class="quarto-color-scheme-extra" id="quarto-bootstrap" data-mode="light">
82<script id="quarto-search-options" type="application/json">{
83 "location": "navbar",
84 "copy-button": false,
85 "collapse-after": 3,
86 "panel-placement": "end",
87 "type": "overlay",
88 "limit": 50,
89 "keyboard-shortcut": [
90 "f",
91 "/",
92 "s"
93 ],
94 "show-item-context": false,
95 "language": {
96 "search-no-results-text": "No results",
97 "search-matching-documents-text": "matching documents",
98 "search-copy-link-title": "Copy link to search",
99 "search-hide-matches-text": "Hide additional matches",
100 "search-more-match-text": "more match in this document",
101 "search-more-matches-text": "more matches in this document",
102 "search-clear-button-title": "Clear",
103 "search-text-placeholder": "",
104 "search-detached-cancel-button-title": "Cancel",
105 "search-submit-button-title": "Submit",
106 "search-label": "Search"
107 }
108}</script>
109
110
111<link rel="stylesheet" href="../assets/styles.css">
112</head>
113
114<body class="nav-fixed quarto-light"><script id="quarto-html-before-body" type="application/javascript">
115 const toggleBodyColorMode = (bsSheetEl) => {
116 const mode = bsSheetEl.getAttribute("data-mode");
117 const bodyEl = window.document.querySelector("body");
118 if (mode === "dark") {
119 bodyEl.classList.add("quarto-dark");
120 bodyEl.classList.remove("quarto-light");
121 } else {
122 bodyEl.classList.add("quarto-light");
123 bodyEl.classList.remove("quarto-dark");
124 }
125 }
126 const toggleBodyColorPrimary = () => {
127 const bsSheetEl = window.document.querySelector("link#quarto-bootstrap:not([rel=disabled-stylesheet])");
128 if (bsSheetEl) {
129 toggleBodyColorMode(bsSheetEl);
130 }
131 }
132 const setColorSchemeToggle = (alternate) => {
133 const toggles = window.document.querySelectorAll('.quarto-color-scheme-toggle');
134 for (let i=0; i < toggles.length; i++) {
135 const toggle = toggles[i];
136 if (toggle) {
137 if (alternate) {
138 toggle.classList.add("alternate");
139 } else {
140 toggle.classList.remove("alternate");
141 }
142 }
143 }
144 };
145 const toggleColorMode = (alternate) => {
146 // Switch the stylesheets
147 const primaryStylesheets = window.document.querySelectorAll('link.quarto-color-scheme:not(.quarto-color-alternate)');
148 const alternateStylesheets = window.document.querySelectorAll('link.quarto-color-scheme.quarto-color-alternate');
149 manageTransitions('#quarto-margin-sidebar .nav-link', false);
150 if (alternate) {
151 // note: dark is layered on light, we don't disable primary!
152 enableStylesheet(alternateStylesheets);
153 for (const sheetNode of alternateStylesheets) {
154 if (sheetNode.id === "quarto-bootstrap") {
155 toggleBodyColorMode(sheetNode);
156 }
157 }
158 } else {
159 disableStylesheet(alternateStylesheets);
160 enableStylesheet(primaryStylesheets)
161 toggleBodyColorPrimary();
162 }
163 manageTransitions('#quarto-margin-sidebar .nav-link', true);
164 // Switch the toggles
165 setColorSchemeToggle(alternate)
166 // Hack to workaround the fact that safari doesn't
167 // properly recolor the scrollbar when toggling (#1455)
168 if (navigator.userAgent.indexOf('Safari') > 0 && navigator.userAgent.indexOf('Chrome') == -1) {
169 manageTransitions("body", false);
170 window.scrollTo(0, 1);
171 setTimeout(() => {
172 window.scrollTo(0, 0);
173 manageTransitions("body", true);
174 }, 40);
175 }
176 }
177 const disableStylesheet = (stylesheets) => {
178 for (let i=0; i < stylesheets.length; i++) {
179 const stylesheet = stylesheets[i];
180 stylesheet.rel = 'disabled-stylesheet';
181 }
182 }
183 const enableStylesheet = (stylesheets) => {
184 for (let i=0; i < stylesheets.length; i++) {
185 const stylesheet = stylesheets[i];
186 if(stylesheet.rel !== 'stylesheet') { // for Chrome, which will still FOUC without this check
187 stylesheet.rel = 'stylesheet';
188 }
189 }
190 }
191 const manageTransitions = (selector, allowTransitions) => {
192 const els = window.document.querySelectorAll(selector);
193 for (let i=0; i < els.length; i++) {
194 const el = els[i];
195 if (allowTransitions) {
196 el.classList.remove('notransition');
197 } else {
198 el.classList.add('notransition');
199 }
200 }
201 }
202 const isFileUrl = () => {
203 return window.location.protocol === 'file:';
204 }
205 const hasAlternateSentinel = () => {
206 let styleSentinel = getColorSchemeSentinel();
207 if (styleSentinel !== null) {
208 return styleSentinel === "alternate";
209 } else {
210 return false;
211 }
212 }
213 const setStyleSentinel = (alternate) => {
214 const value = alternate ? "alternate" : "default";
215 if (!isFileUrl()) {
216 window.localStorage.setItem("quarto-color-scheme", value);
217 } else {
218 localAlternateSentinel = value;
219 }
220 }
221 const getColorSchemeSentinel = () => {
222 if (!isFileUrl()) {
223 const storageValue = window.localStorage.getItem("quarto-color-scheme");
224 return storageValue != null ? storageValue : localAlternateSentinel;
225 } else {
226 return localAlternateSentinel;
227 }
228 }
229 const toggleGiscusIfUsed = (isAlternate, darkModeDefault) => {
230 const baseTheme = document.querySelector('#giscus-base-theme')?.value ?? 'light';
231 const alternateTheme = document.querySelector('#giscus-alt-theme')?.value ?? 'dark';
232 let newTheme = '';
233 if(authorPrefersDark) {
234 newTheme = isAlternate ? baseTheme : alternateTheme;
235 } else {
236 newTheme = isAlternate ? alternateTheme : baseTheme;
237 }
238 const changeGiscusTheme = () => {
239 // From: https://github.com/giscus/giscus/issues/336
240 const sendMessage = (message) => {
241 const iframe = document.querySelector('iframe.giscus-frame');
242 if (!iframe) return;
243 iframe.contentWindow.postMessage({ giscus: message }, 'https://giscus.app');
244 }
245 sendMessage({
246 setConfig: {
247 theme: newTheme
248 }
249 });
250 }
251 const isGiscussLoaded = window.document.querySelector('iframe.giscus-frame') !== null;
252 if (isGiscussLoaded) {
253 changeGiscusTheme();
254 }
255 };
256 const authorPrefersDark = false;
257 const darkModeDefault = authorPrefersDark;
258 document.querySelector('link#quarto-text-highlighting-styles.quarto-color-scheme-extra').rel = 'disabled-stylesheet';
259 document.querySelector('link#quarto-bootstrap.quarto-color-scheme-extra').rel = 'disabled-stylesheet';
260 let localAlternateSentinel = darkModeDefault ? 'alternate' : 'default';
261 // Dark / light mode switch
262 window.quartoToggleColorScheme = () => {
263 // Read the current dark / light value
264 let toAlternate = !hasAlternateSentinel();
265 toggleColorMode(toAlternate);
266 setStyleSentinel(toAlternate);
267 toggleGiscusIfUsed(toAlternate, darkModeDefault);
268 window.dispatchEvent(new Event('resize'));
269 };
270 // Switch to dark mode if need be
271 if (hasAlternateSentinel()) {
272 toggleColorMode(true);
273 } else {
274 toggleColorMode(false);
275 }
276 </script>
277
278<div id="quarto-search-results"></div>
279 <header id="quarto-header" class="headroom fixed-top">
280 <nav class="navbar navbar-expand-lg " data-bs-theme="dark">
281 <div class="navbar-container container-fluid">
282 <div class="navbar-brand-container mx-auto">
283 <a class="navbar-brand" href="../index.html">
284 <span class="navbar-title">atdata</span>
285 </a>
286 </div>
287 <div id="quarto-search" class="" title="Search"></div>
288 <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarCollapse" aria-controls="navbarCollapse" role="menu" aria-expanded="false" aria-label="Toggle navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
289 <span class="navbar-toggler-icon"></span>
290</button>
291 <div class="collapse navbar-collapse" id="navbarCollapse">
292 <ul class="navbar-nav navbar-nav-scroll me-auto">
293 <li class="nav-item">
294 <a class="nav-link" href="../index.html">
295<span class="menu-text">Guide</span></a>
296 </li>
297 <li class="nav-item dropdown ">
298 <a class="nav-link dropdown-toggle" href="#" id="nav-menu-tutorials" role="link" data-bs-toggle="dropdown" aria-expanded="false">
299 <span class="menu-text">Tutorials</span>
300 </a>
301 <ul class="dropdown-menu" aria-labelledby="nav-menu-tutorials">
302 <li>
303 <a class="dropdown-item" href="../tutorials/quickstart.html">
304 <span class="dropdown-text">Quick Start</span></a>
305 </li>
306 <li>
307 <a class="dropdown-item" href="../tutorials/local-workflow.html">
308 <span class="dropdown-text">Local Workflow</span></a>
309 </li>
310 <li>
311 <a class="dropdown-item" href="../tutorials/atmosphere.html">
312 <span class="dropdown-text">Atmosphere Publishing</span></a>
313 </li>
314 <li>
315 <a class="dropdown-item" href="../tutorials/promotion.html">
316 <span class="dropdown-text">Promotion Workflow</span></a>
317 </li>
318 </ul>
319 </li>
320 <li class="nav-item dropdown ">
321 <a class="nav-link dropdown-toggle" href="#" id="nav-menu-reference" role="link" data-bs-toggle="dropdown" aria-expanded="false">
322 <span class="menu-text">Reference</span>
323 </a>
324 <ul class="dropdown-menu" aria-labelledby="nav-menu-reference">
325 <li>
326 <a class="dropdown-item" href="../reference/architecture.html">
327 <span class="dropdown-text">Architecture Overview</span></a>
328 </li>
329 <li>
330 <a class="dropdown-item" href="../reference/packable-samples.html">
331 <span class="dropdown-text">Packable Samples</span></a>
332 </li>
333 <li>
334 <a class="dropdown-item" href="../reference/datasets.html">
335 <span class="dropdown-text">Datasets</span></a>
336 </li>
337 <li>
338 <a class="dropdown-item" href="../reference/lenses.html">
339 <span class="dropdown-text">Lenses</span></a>
340 </li>
341 <li>
342 <a class="dropdown-item" href="../reference/local-storage.html">
343 <span class="dropdown-text">Local Storage</span></a>
344 </li>
345 <li>
346 <a class="dropdown-item" href="../reference/atmosphere.html">
347 <span class="dropdown-text">Atmosphere</span></a>
348 </li>
349 <li>
350 <a class="dropdown-item" href="../reference/promotion.html">
351 <span class="dropdown-text">Promotion</span></a>
352 </li>
353 <li>
354 <a class="dropdown-item" href="../reference/load-dataset.html">
355 <span class="dropdown-text">load_dataset API</span></a>
356 </li>
357 <li>
358 <a class="dropdown-item" href="../reference/protocols.html">
359 <span class="dropdown-text">Protocols</span></a>
360 </li>
361 <li>
362 <a class="dropdown-item" href="../reference/uri-spec.html">
363 <span class="dropdown-text">URI Specification</span></a>
364 </li>
365 <li>
366 <a class="dropdown-item" href="../reference/troubleshooting.html">
367 <span class="dropdown-text">Troubleshooting & FAQ</span></a>
368 </li>
369 <li>
370 <a class="dropdown-item" href="../reference/deployment.html">
371 <span class="dropdown-text">Deployment Guide</span></a>
372 </li>
373 </ul>
374 </li>
375 <li class="nav-item">
376 <a class="nav-link" href="../api/index.html">
377<span class="menu-text">API</span></a>
378 </li>
379</ul>
380 <ul class="navbar-nav navbar-nav-scroll ms-auto">
381 <li class="nav-item compact">
382 <a class="nav-link" href="https://github.com/your-org/atdata"> <i class="bi bi-github" role="img">
383</i>
384<span class="menu-text"></span></a>
385 </li>
386</ul>
387 </div> <!-- /navcollapse -->
388 <div class="quarto-navbar-tools">
389 <a href="" class="quarto-color-scheme-toggle quarto-navigation-tool px-1" onclick="window.quartoToggleColorScheme(); return false;" title="Toggle dark mode"><i class="bi"></i></a>
390</div>
391 </div> <!-- /container-fluid -->
392 </nav>
393</header>
394<!-- content -->
395<div id="quarto-content" class="quarto-container page-columns page-rows-contents page-layout-article page-navbar">
396<!-- sidebar -->
397<!-- margin-sidebar -->
398 <div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
399 <nav id="TOC" role="doc-toc" class="toc-active">
400 <h2 id="toc-title">On this page</h2>
401
402 <ul>
403 <li><a href="#atdata.DatasetDict" id="toc-atdata.DatasetDict" class="nav-link active" data-scroll-target="#atdata.DatasetDict">DatasetDict</a>
404 <ul class="collapse">
405 <li><a href="#parameters" id="toc-parameters" class="nav-link" data-scroll-target="#parameters">Parameters</a></li>
406 <li><a href="#examples" id="toc-examples" class="nav-link" data-scroll-target="#examples">Examples</a></li>
407 <li><a href="#attributes" id="toc-attributes" class="nav-link" data-scroll-target="#attributes">Attributes</a></li>
408 </ul></li>
409 </ul>
410<div class="toc-actions"><ul><li><a href="https://github.com/your-org/atdata/edit/main/api/DatasetDict.qmd" class="toc-action"><i class="bi bi-github"></i>Edit this page</a></li><li><a href="https://github.com/your-org/atdata/issues/new" class="toc-action"><i class="bi empty"></i>Report an issue</a></li></ul></div></nav>
411 </div>
412<!-- main -->
413<main class="content" id="quarto-document-content"><header id="title-block-header" class="quarto-title-block"></header>
414
415
416
417
418
419<section id="atdata.DatasetDict" class="level1">
420<h1>DatasetDict</h1>
421<div class="sourceCode" id="cb1"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a>DatasetDict(splits<span class="op">=</span><span class="va">None</span>, sample_type<span class="op">=</span><span class="va">None</span>, streaming<span class="op">=</span><span class="va">False</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
422<p>A dictionary of split names to Dataset instances.</p>
423<p>Similar to HuggingFace’s DatasetDict, this provides a container for multiple dataset splits (train, test, validation, etc.) with convenience methods that operate across all splits.</p>
424<section id="parameters" class="level2 doc-section doc-section-parameters">
425<h2 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters">Parameters</h2>
426<table class="caption-top table">
427<colgroup>
428<col style="width: 10%">
429<col style="width: 10%">
430<col style="width: 63%">
431<col style="width: 15%">
432</colgroup>
433<thead>
434<tr class="header">
435<th>Name</th>
436<th>Type</th>
437<th>Description</th>
438<th>Default</th>
439</tr>
440</thead>
441<tbody>
442<tr class="odd">
443<td>ST</td>
444<td></td>
445<td>The sample type for all datasets in this dict.</td>
446<td><em>required</em></td>
447</tr>
448</tbody>
449</table>
450</section>
451<section id="examples" class="level2 doc-section doc-section-examples">
452<h2 class="doc-section doc-section-examples anchored" data-anchor-id="examples">Examples</h2>
453<div class="sourceCode" id="cb2"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="op">>>></span> ds_dict <span class="op">=</span> load_dataset(<span class="st">"path/to/data"</span>, MyData)</span>
454<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="op">>>></span> train <span class="op">=</span> ds_dict[<span class="st">"train"</span>]</span>
455<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a><span class="op">>>></span> test <span class="op">=</span> ds_dict[<span class="st">"test"</span>]</span>
456<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a><span class="op">>>></span></span>
457<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a><span class="op">>>></span> <span class="co"># Iterate over all splits</span></span>
458<span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a><span class="op">>>></span> <span class="cf">for</span> split_name, dataset <span class="kw">in</span> ds_dict.items():</span>
459<span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a>... <span class="bu">print</span>(<span class="ss">f"</span><span class="sc">{</span>split_name<span class="sc">}</span><span class="ss">: </span><span class="sc">{</span><span class="bu">len</span>(dataset.shard_list)<span class="sc">}</span><span class="ss"> shards"</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
460</section>
461<section id="attributes" class="level2">
462<h2 class="anchored" data-anchor-id="attributes">Attributes</h2>
463<table class="caption-top table">
464<thead>
465<tr class="header">
466<th>Name</th>
467<th>Description</th>
468</tr>
469</thead>
470<tbody>
471<tr class="odd">
472<td><a href="#atdata.DatasetDict.num_shards">num_shards</a></td>
473<td>Number of shards in each split.</td>
474</tr>
475<tr class="even">
476<td><a href="#atdata.DatasetDict.sample_type">sample_type</a></td>
477<td>The sample type for datasets in this dict.</td>
478</tr>
479<tr class="odd">
480<td><a href="#atdata.DatasetDict.streaming">streaming</a></td>
481<td>Whether this DatasetDict was loaded in streaming mode.</td>
482</tr>
483</tbody>
484</table>
485
486
487</section>
488</section>
489
490</main> <!-- /main -->
491<script id="quarto-html-after-body" type="application/javascript">
492 window.document.addEventListener("DOMContentLoaded", function (event) {
493 // Ensure there is a toggle, if there isn't float one in the top right
494 if (window.document.querySelector('.quarto-color-scheme-toggle') === null) {
495 const a = window.document.createElement('a');
496 a.classList.add('top-right');
497 a.classList.add('quarto-color-scheme-toggle');
498 a.href = "";
499 a.onclick = function() { try { window.quartoToggleColorScheme(); } catch {} return false; };
500 const i = window.document.createElement("i");
501 i.classList.add('bi');
502 a.appendChild(i);
503 window.document.body.appendChild(a);
504 }
505 setColorSchemeToggle(hasAlternateSentinel())
506 const icon = "";
507 const anchorJS = new window.AnchorJS();
508 anchorJS.options = {
509 placement: 'right',
510 icon: icon
511 };
512 anchorJS.add('.anchored');
513 const isCodeAnnotation = (el) => {
514 for (const clz of el.classList) {
515 if (clz.startsWith('code-annotation-')) {
516 return true;
517 }
518 }
519 return false;
520 }
521 const onCopySuccess = function(e) {
522 // button target
523 const button = e.trigger;
524 // don't keep focus
525 button.blur();
526 // flash "checked"
527 button.classList.add('code-copy-button-checked');
528 var currentTitle = button.getAttribute("title");
529 button.setAttribute("title", "Copied!");
530 let tooltip;
531 if (window.bootstrap) {
532 button.setAttribute("data-bs-toggle", "tooltip");
533 button.setAttribute("data-bs-placement", "left");
534 button.setAttribute("data-bs-title", "Copied!");
535 tooltip = new bootstrap.Tooltip(button,
536 { trigger: "manual",
537 customClass: "code-copy-button-tooltip",
538 offset: [0, -8]});
539 tooltip.show();
540 }
541 setTimeout(function() {
542 if (tooltip) {
543 tooltip.hide();
544 button.removeAttribute("data-bs-title");
545 button.removeAttribute("data-bs-toggle");
546 button.removeAttribute("data-bs-placement");
547 }
548 button.setAttribute("title", currentTitle);
549 button.classList.remove('code-copy-button-checked');
550 }, 1000);
551 // clear code selection
552 e.clearSelection();
553 }
554 const getTextToCopy = function(trigger) {
555 const codeEl = trigger.previousElementSibling.cloneNode(true);
556 for (const childEl of codeEl.children) {
557 if (isCodeAnnotation(childEl)) {
558 childEl.remove();
559 }
560 }
561 return codeEl.innerText;
562 }
563 const clipboard = new window.ClipboardJS('.code-copy-button:not([data-in-quarto-modal])', {
564 text: getTextToCopy
565 });
566 clipboard.on('success', onCopySuccess);
567 if (window.document.getElementById('quarto-embedded-source-code-modal')) {
568 const clipboardModal = new window.ClipboardJS('.code-copy-button[data-in-quarto-modal]', {
569 text: getTextToCopy,
570 container: window.document.getElementById('quarto-embedded-source-code-modal')
571 });
572 clipboardModal.on('success', onCopySuccess);
573 }
574 var localhostRegex = new RegExp(/^(?:http|https):\/\/localhost\:?[0-9]*\//);
575 var mailtoRegex = new RegExp(/^mailto:/);
576 var filterRegex = new RegExp("https:\/\/github\.com\/your-org\/atdata");
577 var isInternal = (href) => {
578 return filterRegex.test(href) || localhostRegex.test(href) || mailtoRegex.test(href);
579 }
580 // Inspect non-navigation links and adorn them if external
581 var links = window.document.querySelectorAll('a[href]:not(.nav-link):not(.navbar-brand):not(.toc-action):not(.sidebar-link):not(.sidebar-item-toggle):not(.pagination-link):not(.no-external):not([aria-hidden]):not(.dropdown-item):not(.quarto-navigation-tool):not(.about-link)');
582 for (var i=0; i<links.length; i++) {
583 const link = links[i];
584 if (!isInternal(link.href)) {
585 // undo the damage that might have been done by quarto-nav.js in the case of
586 // links that we want to consider external
587 if (link.dataset.originalHref !== undefined) {
588 link.href = link.dataset.originalHref;
589 }
590 }
591 }
592 function tippyHover(el, contentFn, onTriggerFn, onUntriggerFn) {
593 const config = {
594 allowHTML: true,
595 maxWidth: 500,
596 delay: 100,
597 arrow: false,
598 appendTo: function(el) {
599 return el.parentElement;
600 },
601 interactive: true,
602 interactiveBorder: 10,
603 theme: 'quarto',
604 placement: 'bottom-start',
605 };
606 if (contentFn) {
607 config.content = contentFn;
608 }
609 if (onTriggerFn) {
610 config.onTrigger = onTriggerFn;
611 }
612 if (onUntriggerFn) {
613 config.onUntrigger = onUntriggerFn;
614 }
615 window.tippy(el, config);
616 }
617 const noterefs = window.document.querySelectorAll('a[role="doc-noteref"]');
618 for (var i=0; i<noterefs.length; i++) {
619 const ref = noterefs[i];
620 tippyHover(ref, function() {
621 // use id or data attribute instead here
622 let href = ref.getAttribute('data-footnote-href') || ref.getAttribute('href');
623 try { href = new URL(href).hash; } catch {}
624 const id = href.replace(/^#\/?/, "");
625 const note = window.document.getElementById(id);
626 if (note) {
627 return note.innerHTML;
628 } else {
629 return "";
630 }
631 });
632 }
633 const xrefs = window.document.querySelectorAll('a.quarto-xref');
634 const processXRef = (id, note) => {
635 // Strip column container classes
636 const stripColumnClz = (el) => {
637 el.classList.remove("page-full", "page-columns");
638 if (el.children) {
639 for (const child of el.children) {
640 stripColumnClz(child);
641 }
642 }
643 }
644 stripColumnClz(note)
645 if (id === null || id.startsWith('sec-')) {
646 // Special case sections, only their first couple elements
647 const container = document.createElement("div");
648 if (note.children && note.children.length > 2) {
649 container.appendChild(note.children[0].cloneNode(true));
650 for (let i = 1; i < note.children.length; i++) {
651 const child = note.children[i];
652 if (child.tagName === "P" && child.innerText === "") {
653 continue;
654 } else {
655 container.appendChild(child.cloneNode(true));
656 break;
657 }
658 }
659 if (window.Quarto?.typesetMath) {
660 window.Quarto.typesetMath(container);
661 }
662 return container.innerHTML
663 } else {
664 if (window.Quarto?.typesetMath) {
665 window.Quarto.typesetMath(note);
666 }
667 return note.innerHTML;
668 }
669 } else {
670 // Remove any anchor links if they are present
671 const anchorLink = note.querySelector('a.anchorjs-link');
672 if (anchorLink) {
673 anchorLink.remove();
674 }
675 if (window.Quarto?.typesetMath) {
676 window.Quarto.typesetMath(note);
677 }
678 if (note.classList.contains("callout")) {
679 return note.outerHTML;
680 } else {
681 return note.innerHTML;
682 }
683 }
684 }
685 for (var i=0; i<xrefs.length; i++) {
686 const xref = xrefs[i];
687 tippyHover(xref, undefined, function(instance) {
688 instance.disable();
689 let url = xref.getAttribute('href');
690 let hash = undefined;
691 if (url.startsWith('#')) {
692 hash = url;
693 } else {
694 try { hash = new URL(url).hash; } catch {}
695 }
696 if (hash) {
697 const id = hash.replace(/^#\/?/, "");
698 const note = window.document.getElementById(id);
699 if (note !== null) {
700 try {
701 const html = processXRef(id, note.cloneNode(true));
702 instance.setContent(html);
703 } finally {
704 instance.enable();
705 instance.show();
706 }
707 } else {
708 // See if we can fetch this
709 fetch(url.split('#')[0])
710 .then(res => res.text())
711 .then(html => {
712 const parser = new DOMParser();
713 const htmlDoc = parser.parseFromString(html, "text/html");
714 const note = htmlDoc.getElementById(id);
715 if (note !== null) {
716 const html = processXRef(id, note);
717 instance.setContent(html);
718 }
719 }).finally(() => {
720 instance.enable();
721 instance.show();
722 });
723 }
724 } else {
725 // See if we can fetch a full url (with no hash to target)
726 // This is a special case and we should probably do some content thinning / targeting
727 fetch(url)
728 .then(res => res.text())
729 .then(html => {
730 const parser = new DOMParser();
731 const htmlDoc = parser.parseFromString(html, "text/html");
732 const note = htmlDoc.querySelector('main.content');
733 if (note !== null) {
734 // This should only happen for chapter cross references
735 // (since there is no id in the URL)
736 // remove the first header
737 if (note.children.length > 0 && note.children[0].tagName === "HEADER") {
738 note.children[0].remove();
739 }
740 const html = processXRef(null, note);
741 instance.setContent(html);
742 }
743 }).finally(() => {
744 instance.enable();
745 instance.show();
746 });
747 }
748 }, function(instance) {
749 });
750 }
751 let selectedAnnoteEl;
752 const selectorForAnnotation = ( cell, annotation) => {
753 let cellAttr = 'data-code-cell="' + cell + '"';
754 let lineAttr = 'data-code-annotation="' + annotation + '"';
755 const selector = 'span[' + cellAttr + '][' + lineAttr + ']';
756 return selector;
757 }
758 const selectCodeLines = (annoteEl) => {
759 const doc = window.document;
760 const targetCell = annoteEl.getAttribute("data-target-cell");
761 const targetAnnotation = annoteEl.getAttribute("data-target-annotation");
762 const annoteSpan = window.document.querySelector(selectorForAnnotation(targetCell, targetAnnotation));
763 const lines = annoteSpan.getAttribute("data-code-lines").split(",");
764 const lineIds = lines.map((line) => {
765 return targetCell + "-" + line;
766 })
767 let top = null;
768 let height = null;
769 let parent = null;
770 if (lineIds.length > 0) {
771 //compute the position of the single el (top and bottom and make a div)
772 const el = window.document.getElementById(lineIds[0]);
773 top = el.offsetTop;
774 height = el.offsetHeight;
775 parent = el.parentElement.parentElement;
776 if (lineIds.length > 1) {
777 const lastEl = window.document.getElementById(lineIds[lineIds.length - 1]);
778 const bottom = lastEl.offsetTop + lastEl.offsetHeight;
779 height = bottom - top;
780 }
781 if (top !== null && height !== null && parent !== null) {
782 // cook up a div (if necessary) and position it
783 let div = window.document.getElementById("code-annotation-line-highlight");
784 if (div === null) {
785 div = window.document.createElement("div");
786 div.setAttribute("id", "code-annotation-line-highlight");
787 div.style.position = 'absolute';
788 parent.appendChild(div);
789 }
790 div.style.top = top - 2 + "px";
791 div.style.height = height + 4 + "px";
792 div.style.left = 0;
793 let gutterDiv = window.document.getElementById("code-annotation-line-highlight-gutter");
794 if (gutterDiv === null) {
795 gutterDiv = window.document.createElement("div");
796 gutterDiv.setAttribute("id", "code-annotation-line-highlight-gutter");
797 gutterDiv.style.position = 'absolute';
798 const codeCell = window.document.getElementById(targetCell);
799 const gutter = codeCell.querySelector('.code-annotation-gutter');
800 gutter.appendChild(gutterDiv);
801 }
802 gutterDiv.style.top = top - 2 + "px";
803 gutterDiv.style.height = height + 4 + "px";
804 }
805 selectedAnnoteEl = annoteEl;
806 }
807 };
808 const unselectCodeLines = () => {
809 const elementsIds = ["code-annotation-line-highlight", "code-annotation-line-highlight-gutter"];
810 elementsIds.forEach((elId) => {
811 const div = window.document.getElementById(elId);
812 if (div) {
813 div.remove();
814 }
815 });
816 selectedAnnoteEl = undefined;
817 };
818 // Handle positioning of the toggle
819 window.addEventListener(
820 "resize",
821 throttle(() => {
822 elRect = undefined;
823 if (selectedAnnoteEl) {
824 selectCodeLines(selectedAnnoteEl);
825 }
826 }, 10)
827 );
828 function throttle(fn, ms) {
829 let throttle = false;
830 let timer;
831 return (...args) => {
832 if(!throttle) { // first call gets through
833 fn.apply(this, args);
834 throttle = true;
835 } else { // all the others get throttled
836 if(timer) clearTimeout(timer); // cancel #2
837 timer = setTimeout(() => {
838 fn.apply(this, args);
839 timer = throttle = false;
840 }, ms);
841 }
842 };
843 }
844 // Attach click handler to the DT
845 const annoteDls = window.document.querySelectorAll('dt[data-target-cell]');
846 for (const annoteDlNode of annoteDls) {
847 annoteDlNode.addEventListener('click', (event) => {
848 const clickedEl = event.target;
849 if (clickedEl !== selectedAnnoteEl) {
850 unselectCodeLines();
851 const activeEl = window.document.querySelector('dt[data-target-cell].code-annotation-active');
852 if (activeEl) {
853 activeEl.classList.remove('code-annotation-active');
854 }
855 selectCodeLines(clickedEl);
856 clickedEl.classList.add('code-annotation-active');
857 } else {
858 // Unselect the line
859 unselectCodeLines();
860 clickedEl.classList.remove('code-annotation-active');
861 }
862 });
863 }
864 const findCites = (el) => {
865 const parentEl = el.parentElement;
866 if (parentEl) {
867 const cites = parentEl.dataset.cites;
868 if (cites) {
869 return {
870 el,
871 cites: cites.split(' ')
872 };
873 } else {
874 return findCites(el.parentElement)
875 }
876 } else {
877 return undefined;
878 }
879 };
880 var bibliorefs = window.document.querySelectorAll('a[role="doc-biblioref"]');
881 for (var i=0; i<bibliorefs.length; i++) {
882 const ref = bibliorefs[i];
883 const citeInfo = findCites(ref);
884 if (citeInfo) {
885 tippyHover(citeInfo.el, function() {
886 var popup = window.document.createElement('div');
887 citeInfo.cites.forEach(function(cite) {
888 var citeDiv = window.document.createElement('div');
889 citeDiv.classList.add('hanging-indent');
890 citeDiv.classList.add('csl-entry');
891 var biblioDiv = window.document.getElementById('ref-' + cite);
892 if (biblioDiv) {
893 citeDiv.innerHTML = biblioDiv.innerHTML;
894 }
895 popup.appendChild(citeDiv);
896 });
897 return popup.innerHTML;
898 });
899 }
900 }
901 });
902 </script>
903</div> <!-- /content -->
904<footer class="footer">
905 <div class="nav-footer">
906 <div class="nav-footer-left">
907<p>Built with <a href="https://quarto.org/">Quarto</a></p>
908</div>
909 <div class="nav-footer-center">
910
911 <div class="toc-actions d-sm-block d-md-none"><ul><li><a href="https://github.com/your-org/atdata/edit/main/api/DatasetDict.qmd" class="toc-action"><i class="bi bi-github"></i>Edit this page</a></li><li><a href="https://github.com/your-org/atdata/issues/new" class="toc-action"><i class="bi empty"></i>Report an issue</a></li></ul></div></div>
912 <div class="nav-footer-right">
913<p>MIT License</p>
914</div>
915 </div>
916</footer>
917
918
919
920
921</body></html>