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>packablesample – 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.PackableSample" id="toc-atdata.PackableSample" class="nav-link active" data-scroll-target="#atdata.PackableSample">PackableSample</a>
404 <ul class="collapse">
405 <li><a href="#examples" id="toc-examples" class="nav-link" data-scroll-target="#examples">Examples</a></li>
406 <li><a href="#attributes" id="toc-attributes" class="nav-link" data-scroll-target="#attributes">Attributes</a></li>
407 <li><a href="#methods" id="toc-methods" class="nav-link" data-scroll-target="#methods">Methods</a>
408 <ul class="collapse">
409 <li><a href="#atdata.PackableSample.from_bytes" id="toc-atdata.PackableSample.from_bytes" class="nav-link" data-scroll-target="#atdata.PackableSample.from_bytes">from_bytes</a></li>
410 <li><a href="#atdata.PackableSample.from_data" id="toc-atdata.PackableSample.from_data" class="nav-link" data-scroll-target="#atdata.PackableSample.from_data">from_data</a></li>
411 </ul></li>
412 </ul></li>
413 </ul>
414<div class="toc-actions"><ul><li><a href="https://github.com/your-org/atdata/edit/main/api/PackableSample.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>
415 </div>
416<!-- main -->
417<main class="content" id="quarto-document-content"><header id="title-block-header" class="quarto-title-block"></header>
418
419
420
421
422
423<section id="atdata.PackableSample" class="level1">
424<h1>PackableSample</h1>
425<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>PackableSample()</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
426<p>Base class for samples that can be serialized with msgpack.</p>
427<p>This abstract base class provides automatic serialization/deserialization for dataclass-based samples. Fields annotated as <code>NDArray</code> or <code>NDArray | None</code> are automatically converted between numpy arrays and bytes during packing/unpacking.</p>
428<p>Subclasses should be defined either by: 1. Direct inheritance with the <code>@dataclass</code> decorator 2. Using the <code>@packable</code> decorator (recommended)</p>
429<section id="examples" class="level2 doc-section doc-section-examples">
430<h2 class="doc-section doc-section-examples anchored" data-anchor-id="examples">Examples</h2>
431<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> <span class="op">@</span>packable</span>
432<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a>... <span class="kw">class</span> MyData:</span>
433<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a>... name: <span class="bu">str</span></span>
434<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a>... embeddings: NDArray</span>
435<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a>...</span>
436<span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a><span class="op">>>></span> sample <span class="op">=</span> MyData(name<span class="op">=</span><span class="st">"test"</span>, embeddings<span class="op">=</span>np.array([<span class="fl">1.0</span>, <span class="fl">2.0</span>]))</span>
437<span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a><span class="op">>>></span> packed <span class="op">=</span> sample.packed <span class="co"># Serialize to bytes</span></span>
438<span id="cb2-8"><a href="#cb2-8" aria-hidden="true" tabindex="-1"></a><span class="op">>>></span> restored <span class="op">=</span> MyData.from_bytes(packed) <span class="co"># Deserialize</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
439</section>
440<section id="attributes" class="level2">
441<h2 class="anchored" data-anchor-id="attributes">Attributes</h2>
442<table class="caption-top table">
443<thead>
444<tr class="header">
445<th>Name</th>
446<th>Description</th>
447</tr>
448</thead>
449<tbody>
450<tr class="odd">
451<td><a href="#atdata.PackableSample.as_wds">as_wds</a></td>
452<td>Pack this sample’s data for writing to WebDataset.</td>
453</tr>
454<tr class="even">
455<td><a href="#atdata.PackableSample.packed">packed</a></td>
456<td>Pack this sample’s data into msgpack bytes.</td>
457</tr>
458</tbody>
459</table>
460</section>
461<section id="methods" class="level2">
462<h2 class="anchored" data-anchor-id="methods">Methods</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.PackableSample.from_bytes">from_bytes</a></td>
473<td>Create a sample instance from raw msgpack bytes.</td>
474</tr>
475<tr class="even">
476<td><a href="#atdata.PackableSample.from_data">from_data</a></td>
477<td>Create a sample instance from unpacked msgpack data.</td>
478</tr>
479</tbody>
480</table>
481<section id="atdata.PackableSample.from_bytes" class="level3">
482<h3 class="anchored" data-anchor-id="atdata.PackableSample.from_bytes">from_bytes</h3>
483<div class="sourceCode" id="cb3"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a>PackableSample.from_bytes(bs)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
484<p>Create a sample instance from raw msgpack bytes.</p>
485<section id="parameters" class="level4 doc-section doc-section-parameters">
486<h4 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters">Parameters</h4>
487<table class="caption-top table">
488<thead>
489<tr class="header">
490<th>Name</th>
491<th>Type</th>
492<th>Description</th>
493<th>Default</th>
494</tr>
495</thead>
496<tbody>
497<tr class="odd">
498<td>bs</td>
499<td><a href="`bytes`">bytes</a></td>
500<td>Raw bytes from a msgpack-serialized sample.</td>
501<td><em>required</em></td>
502</tr>
503</tbody>
504</table>
505</section>
506<section id="returns" class="level4 doc-section doc-section-returns">
507<h4 class="doc-section doc-section-returns anchored" data-anchor-id="returns">Returns</h4>
508<table class="caption-top table">
509<thead>
510<tr class="header">
511<th>Name</th>
512<th>Type</th>
513<th>Description</th>
514</tr>
515</thead>
516<tbody>
517<tr class="odd">
518<td></td>
519<td><a href="`typing.Self`">Self</a></td>
520<td>A new instance of this sample class deserialized from the bytes.</td>
521</tr>
522</tbody>
523</table>
524</section>
525</section>
526<section id="atdata.PackableSample.from_data" class="level3">
527<h3 class="anchored" data-anchor-id="atdata.PackableSample.from_data">from_data</h3>
528<div class="sourceCode" id="cb4"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a>PackableSample.from_data(data)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
529<p>Create a sample instance from unpacked msgpack data.</p>
530<section id="parameters-1" class="level4 doc-section doc-section-parameters">
531<h4 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-1">Parameters</h4>
532<table class="caption-top table">
533<thead>
534<tr class="header">
535<th>Name</th>
536<th>Type</th>
537<th>Description</th>
538<th>Default</th>
539</tr>
540</thead>
541<tbody>
542<tr class="odd">
543<td>data</td>
544<td><a href="`atdata.dataset.WDSRawSample`">WDSRawSample</a></td>
545<td>Dictionary with keys matching the sample’s field names.</td>
546<td><em>required</em></td>
547</tr>
548</tbody>
549</table>
550</section>
551<section id="returns-1" class="level4 doc-section doc-section-returns">
552<h4 class="doc-section doc-section-returns anchored" data-anchor-id="returns-1">Returns</h4>
553<table class="caption-top table">
554<thead>
555<tr class="header">
556<th>Name</th>
557<th>Type</th>
558<th>Description</th>
559</tr>
560</thead>
561<tbody>
562<tr class="odd">
563<td></td>
564<td><a href="`typing.Self`">Self</a></td>
565<td>New instance with NDArray fields auto-converted from bytes.</td>
566</tr>
567</tbody>
568</table>
569
570
571</section>
572</section>
573</section>
574</section>
575
576</main> <!-- /main -->
577<script id="quarto-html-after-body" type="application/javascript">
578 window.document.addEventListener("DOMContentLoaded", function (event) {
579 // Ensure there is a toggle, if there isn't float one in the top right
580 if (window.document.querySelector('.quarto-color-scheme-toggle') === null) {
581 const a = window.document.createElement('a');
582 a.classList.add('top-right');
583 a.classList.add('quarto-color-scheme-toggle');
584 a.href = "";
585 a.onclick = function() { try { window.quartoToggleColorScheme(); } catch {} return false; };
586 const i = window.document.createElement("i");
587 i.classList.add('bi');
588 a.appendChild(i);
589 window.document.body.appendChild(a);
590 }
591 setColorSchemeToggle(hasAlternateSentinel())
592 const icon = "";
593 const anchorJS = new window.AnchorJS();
594 anchorJS.options = {
595 placement: 'right',
596 icon: icon
597 };
598 anchorJS.add('.anchored');
599 const isCodeAnnotation = (el) => {
600 for (const clz of el.classList) {
601 if (clz.startsWith('code-annotation-')) {
602 return true;
603 }
604 }
605 return false;
606 }
607 const onCopySuccess = function(e) {
608 // button target
609 const button = e.trigger;
610 // don't keep focus
611 button.blur();
612 // flash "checked"
613 button.classList.add('code-copy-button-checked');
614 var currentTitle = button.getAttribute("title");
615 button.setAttribute("title", "Copied!");
616 let tooltip;
617 if (window.bootstrap) {
618 button.setAttribute("data-bs-toggle", "tooltip");
619 button.setAttribute("data-bs-placement", "left");
620 button.setAttribute("data-bs-title", "Copied!");
621 tooltip = new bootstrap.Tooltip(button,
622 { trigger: "manual",
623 customClass: "code-copy-button-tooltip",
624 offset: [0, -8]});
625 tooltip.show();
626 }
627 setTimeout(function() {
628 if (tooltip) {
629 tooltip.hide();
630 button.removeAttribute("data-bs-title");
631 button.removeAttribute("data-bs-toggle");
632 button.removeAttribute("data-bs-placement");
633 }
634 button.setAttribute("title", currentTitle);
635 button.classList.remove('code-copy-button-checked');
636 }, 1000);
637 // clear code selection
638 e.clearSelection();
639 }
640 const getTextToCopy = function(trigger) {
641 const codeEl = trigger.previousElementSibling.cloneNode(true);
642 for (const childEl of codeEl.children) {
643 if (isCodeAnnotation(childEl)) {
644 childEl.remove();
645 }
646 }
647 return codeEl.innerText;
648 }
649 const clipboard = new window.ClipboardJS('.code-copy-button:not([data-in-quarto-modal])', {
650 text: getTextToCopy
651 });
652 clipboard.on('success', onCopySuccess);
653 if (window.document.getElementById('quarto-embedded-source-code-modal')) {
654 const clipboardModal = new window.ClipboardJS('.code-copy-button[data-in-quarto-modal]', {
655 text: getTextToCopy,
656 container: window.document.getElementById('quarto-embedded-source-code-modal')
657 });
658 clipboardModal.on('success', onCopySuccess);
659 }
660 var localhostRegex = new RegExp(/^(?:http|https):\/\/localhost\:?[0-9]*\//);
661 var mailtoRegex = new RegExp(/^mailto:/);
662 var filterRegex = new RegExp("https:\/\/github\.com\/your-org\/atdata");
663 var isInternal = (href) => {
664 return filterRegex.test(href) || localhostRegex.test(href) || mailtoRegex.test(href);
665 }
666 // Inspect non-navigation links and adorn them if external
667 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)');
668 for (var i=0; i<links.length; i++) {
669 const link = links[i];
670 if (!isInternal(link.href)) {
671 // undo the damage that might have been done by quarto-nav.js in the case of
672 // links that we want to consider external
673 if (link.dataset.originalHref !== undefined) {
674 link.href = link.dataset.originalHref;
675 }
676 }
677 }
678 function tippyHover(el, contentFn, onTriggerFn, onUntriggerFn) {
679 const config = {
680 allowHTML: true,
681 maxWidth: 500,
682 delay: 100,
683 arrow: false,
684 appendTo: function(el) {
685 return el.parentElement;
686 },
687 interactive: true,
688 interactiveBorder: 10,
689 theme: 'quarto',
690 placement: 'bottom-start',
691 };
692 if (contentFn) {
693 config.content = contentFn;
694 }
695 if (onTriggerFn) {
696 config.onTrigger = onTriggerFn;
697 }
698 if (onUntriggerFn) {
699 config.onUntrigger = onUntriggerFn;
700 }
701 window.tippy(el, config);
702 }
703 const noterefs = window.document.querySelectorAll('a[role="doc-noteref"]');
704 for (var i=0; i<noterefs.length; i++) {
705 const ref = noterefs[i];
706 tippyHover(ref, function() {
707 // use id or data attribute instead here
708 let href = ref.getAttribute('data-footnote-href') || ref.getAttribute('href');
709 try { href = new URL(href).hash; } catch {}
710 const id = href.replace(/^#\/?/, "");
711 const note = window.document.getElementById(id);
712 if (note) {
713 return note.innerHTML;
714 } else {
715 return "";
716 }
717 });
718 }
719 const xrefs = window.document.querySelectorAll('a.quarto-xref');
720 const processXRef = (id, note) => {
721 // Strip column container classes
722 const stripColumnClz = (el) => {
723 el.classList.remove("page-full", "page-columns");
724 if (el.children) {
725 for (const child of el.children) {
726 stripColumnClz(child);
727 }
728 }
729 }
730 stripColumnClz(note)
731 if (id === null || id.startsWith('sec-')) {
732 // Special case sections, only their first couple elements
733 const container = document.createElement("div");
734 if (note.children && note.children.length > 2) {
735 container.appendChild(note.children[0].cloneNode(true));
736 for (let i = 1; i < note.children.length; i++) {
737 const child = note.children[i];
738 if (child.tagName === "P" && child.innerText === "") {
739 continue;
740 } else {
741 container.appendChild(child.cloneNode(true));
742 break;
743 }
744 }
745 if (window.Quarto?.typesetMath) {
746 window.Quarto.typesetMath(container);
747 }
748 return container.innerHTML
749 } else {
750 if (window.Quarto?.typesetMath) {
751 window.Quarto.typesetMath(note);
752 }
753 return note.innerHTML;
754 }
755 } else {
756 // Remove any anchor links if they are present
757 const anchorLink = note.querySelector('a.anchorjs-link');
758 if (anchorLink) {
759 anchorLink.remove();
760 }
761 if (window.Quarto?.typesetMath) {
762 window.Quarto.typesetMath(note);
763 }
764 if (note.classList.contains("callout")) {
765 return note.outerHTML;
766 } else {
767 return note.innerHTML;
768 }
769 }
770 }
771 for (var i=0; i<xrefs.length; i++) {
772 const xref = xrefs[i];
773 tippyHover(xref, undefined, function(instance) {
774 instance.disable();
775 let url = xref.getAttribute('href');
776 let hash = undefined;
777 if (url.startsWith('#')) {
778 hash = url;
779 } else {
780 try { hash = new URL(url).hash; } catch {}
781 }
782 if (hash) {
783 const id = hash.replace(/^#\/?/, "");
784 const note = window.document.getElementById(id);
785 if (note !== null) {
786 try {
787 const html = processXRef(id, note.cloneNode(true));
788 instance.setContent(html);
789 } finally {
790 instance.enable();
791 instance.show();
792 }
793 } else {
794 // See if we can fetch this
795 fetch(url.split('#')[0])
796 .then(res => res.text())
797 .then(html => {
798 const parser = new DOMParser();
799 const htmlDoc = parser.parseFromString(html, "text/html");
800 const note = htmlDoc.getElementById(id);
801 if (note !== null) {
802 const html = processXRef(id, note);
803 instance.setContent(html);
804 }
805 }).finally(() => {
806 instance.enable();
807 instance.show();
808 });
809 }
810 } else {
811 // See if we can fetch a full url (with no hash to target)
812 // This is a special case and we should probably do some content thinning / targeting
813 fetch(url)
814 .then(res => res.text())
815 .then(html => {
816 const parser = new DOMParser();
817 const htmlDoc = parser.parseFromString(html, "text/html");
818 const note = htmlDoc.querySelector('main.content');
819 if (note !== null) {
820 // This should only happen for chapter cross references
821 // (since there is no id in the URL)
822 // remove the first header
823 if (note.children.length > 0 && note.children[0].tagName === "HEADER") {
824 note.children[0].remove();
825 }
826 const html = processXRef(null, note);
827 instance.setContent(html);
828 }
829 }).finally(() => {
830 instance.enable();
831 instance.show();
832 });
833 }
834 }, function(instance) {
835 });
836 }
837 let selectedAnnoteEl;
838 const selectorForAnnotation = ( cell, annotation) => {
839 let cellAttr = 'data-code-cell="' + cell + '"';
840 let lineAttr = 'data-code-annotation="' + annotation + '"';
841 const selector = 'span[' + cellAttr + '][' + lineAttr + ']';
842 return selector;
843 }
844 const selectCodeLines = (annoteEl) => {
845 const doc = window.document;
846 const targetCell = annoteEl.getAttribute("data-target-cell");
847 const targetAnnotation = annoteEl.getAttribute("data-target-annotation");
848 const annoteSpan = window.document.querySelector(selectorForAnnotation(targetCell, targetAnnotation));
849 const lines = annoteSpan.getAttribute("data-code-lines").split(",");
850 const lineIds = lines.map((line) => {
851 return targetCell + "-" + line;
852 })
853 let top = null;
854 let height = null;
855 let parent = null;
856 if (lineIds.length > 0) {
857 //compute the position of the single el (top and bottom and make a div)
858 const el = window.document.getElementById(lineIds[0]);
859 top = el.offsetTop;
860 height = el.offsetHeight;
861 parent = el.parentElement.parentElement;
862 if (lineIds.length > 1) {
863 const lastEl = window.document.getElementById(lineIds[lineIds.length - 1]);
864 const bottom = lastEl.offsetTop + lastEl.offsetHeight;
865 height = bottom - top;
866 }
867 if (top !== null && height !== null && parent !== null) {
868 // cook up a div (if necessary) and position it
869 let div = window.document.getElementById("code-annotation-line-highlight");
870 if (div === null) {
871 div = window.document.createElement("div");
872 div.setAttribute("id", "code-annotation-line-highlight");
873 div.style.position = 'absolute';
874 parent.appendChild(div);
875 }
876 div.style.top = top - 2 + "px";
877 div.style.height = height + 4 + "px";
878 div.style.left = 0;
879 let gutterDiv = window.document.getElementById("code-annotation-line-highlight-gutter");
880 if (gutterDiv === null) {
881 gutterDiv = window.document.createElement("div");
882 gutterDiv.setAttribute("id", "code-annotation-line-highlight-gutter");
883 gutterDiv.style.position = 'absolute';
884 const codeCell = window.document.getElementById(targetCell);
885 const gutter = codeCell.querySelector('.code-annotation-gutter');
886 gutter.appendChild(gutterDiv);
887 }
888 gutterDiv.style.top = top - 2 + "px";
889 gutterDiv.style.height = height + 4 + "px";
890 }
891 selectedAnnoteEl = annoteEl;
892 }
893 };
894 const unselectCodeLines = () => {
895 const elementsIds = ["code-annotation-line-highlight", "code-annotation-line-highlight-gutter"];
896 elementsIds.forEach((elId) => {
897 const div = window.document.getElementById(elId);
898 if (div) {
899 div.remove();
900 }
901 });
902 selectedAnnoteEl = undefined;
903 };
904 // Handle positioning of the toggle
905 window.addEventListener(
906 "resize",
907 throttle(() => {
908 elRect = undefined;
909 if (selectedAnnoteEl) {
910 selectCodeLines(selectedAnnoteEl);
911 }
912 }, 10)
913 );
914 function throttle(fn, ms) {
915 let throttle = false;
916 let timer;
917 return (...args) => {
918 if(!throttle) { // first call gets through
919 fn.apply(this, args);
920 throttle = true;
921 } else { // all the others get throttled
922 if(timer) clearTimeout(timer); // cancel #2
923 timer = setTimeout(() => {
924 fn.apply(this, args);
925 timer = throttle = false;
926 }, ms);
927 }
928 };
929 }
930 // Attach click handler to the DT
931 const annoteDls = window.document.querySelectorAll('dt[data-target-cell]');
932 for (const annoteDlNode of annoteDls) {
933 annoteDlNode.addEventListener('click', (event) => {
934 const clickedEl = event.target;
935 if (clickedEl !== selectedAnnoteEl) {
936 unselectCodeLines();
937 const activeEl = window.document.querySelector('dt[data-target-cell].code-annotation-active');
938 if (activeEl) {
939 activeEl.classList.remove('code-annotation-active');
940 }
941 selectCodeLines(clickedEl);
942 clickedEl.classList.add('code-annotation-active');
943 } else {
944 // Unselect the line
945 unselectCodeLines();
946 clickedEl.classList.remove('code-annotation-active');
947 }
948 });
949 }
950 const findCites = (el) => {
951 const parentEl = el.parentElement;
952 if (parentEl) {
953 const cites = parentEl.dataset.cites;
954 if (cites) {
955 return {
956 el,
957 cites: cites.split(' ')
958 };
959 } else {
960 return findCites(el.parentElement)
961 }
962 } else {
963 return undefined;
964 }
965 };
966 var bibliorefs = window.document.querySelectorAll('a[role="doc-biblioref"]');
967 for (var i=0; i<bibliorefs.length; i++) {
968 const ref = bibliorefs[i];
969 const citeInfo = findCites(ref);
970 if (citeInfo) {
971 tippyHover(citeInfo.el, function() {
972 var popup = window.document.createElement('div');
973 citeInfo.cites.forEach(function(cite) {
974 var citeDiv = window.document.createElement('div');
975 citeDiv.classList.add('hanging-indent');
976 citeDiv.classList.add('csl-entry');
977 var biblioDiv = window.document.getElementById('ref-' + cite);
978 if (biblioDiv) {
979 citeDiv.innerHTML = biblioDiv.innerHTML;
980 }
981 popup.appendChild(citeDiv);
982 });
983 return popup.innerHTML;
984 });
985 }
986 }
987 });
988 </script>
989</div> <!-- /content -->
990<footer class="footer">
991 <div class="nav-footer">
992 <div class="nav-footer-left">
993<p>Built with <a href="https://quarto.org/">Quarto</a></p>
994</div>
995 <div class="nav-footer-center">
996
997 <div class="toc-actions d-sm-block d-md-none"><ul><li><a href="https://github.com/your-org/atdata/edit/main/api/PackableSample.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>
998 <div class="nav-footer-right">
999<p>MIT License</p>
1000</div>
1001 </div>
1002</footer>
1003
1004
1005
1006
1007</body></html>