build based on 556529c

JuliaML · Sep 16, 2024 · 9599d32 · 9599d32
1 parent fc022e5
commit 9599d32
Show file tree

Hide file tree

Showing 10 changed files with 28 additions and 28 deletions.
diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json
@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-14T13:54:04","documenter_version":"1.7.0"}}
+{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-16T16:29:37","documenter_version":"1.7.0"}}
diff --git a/dev/LICENSE/index.html b/dev/LICENSE/index.html
diff --git a/dev/containers/overview/index.html b/dev/containers/overview/index.html
@@ -1,5 +1,5 @@
 <!DOCTYPE html>
 <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Dataset Containers · MLDatasets.jl</title><meta name="title" content="Dataset Containers · MLDatasets.jl"/><meta property="og:title" content="Dataset Containers · MLDatasets.jl"/><meta property="twitter:title" content="Dataset Containers · MLDatasets.jl"/><meta name="description" content="Documentation for MLDatasets.jl."/><meta property="og:description" content="Documentation for MLDatasets.jl."/><meta property="twitter:description" content="Documentation for MLDatasets.jl."/><meta property="og:url" content="https://juliadata.github.io/MLDatasets.jl/stable/containers/overview/"/><meta property="twitter:url" content="https://juliadata.github.io/MLDatasets.jl/stable/containers/overview/"/><link rel="canonical" href="https://juliadata.github.io/MLDatasets.jl/stable/containers/overview/"/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script><link href="../../assets/favicon.ico" rel="icon" type="image/x-icon"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../../"><img src="../../assets/logo.png" alt="MLDatasets.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../../">MLDatasets.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Datasets</span><ul><li><a class="tocitem" href="../../datasets/graphs/">Graphs</a></li><li><a class="tocitem" href="../../datasets/meshes/">Meshes</a></li><li><a class="tocitem" href="../../datasets/misc/">Miscellaneous</a></li><li><a class="tocitem" href="../../datasets/text/">Text</a></li><li><a class="tocitem" href="../../datasets/vision/">Vision</a></li></ul></li><li><span class="tocitem">Creating Datasets</span><ul><li class="is-active"><a class="tocitem" href>Dataset Containers</a></li></ul></li><li><a class="tocitem" href="../../LICENSE/">LICENSE</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Creating Datasets</a></li><li class="is-active"><a href>Dataset Containers</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Dataset Containers</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaML/MLDatasets.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/JuliaML/MLDatasets.jl/blob/master/docs/src/containers/overview.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Dataset-Containers"><a class="docs-heading-anchor" href="#Dataset-Containers">Dataset Containers</a><a id="Dataset-Containers-1"></a><a class="docs-heading-anchor-permalink" href="#Dataset-Containers" title="Permalink"></a></h1><p>MLDatasets.jl contains several reusable data containers for accessing datasets in common storage formats. This feature is a work-in-progress and subject to change.</p><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="MLDatasets.FileDataset" href="#MLDatasets.FileDataset"><code>MLDatasets.FileDataset</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">FileDataset([loadfn = FileIO.load,] paths)
-FileDataset([loadfn = FileIO.load,] dir, pattern = &quot;*&quot;, depth = 4)</code></pre><p>Wrap a set of file <code>paths</code> as a dataset (traversed in the same order as <code>paths</code>). Alternatively, specify a <code>dir</code> and collect all paths that match a glob <code>pattern</code> (recursively globbing by <code>depth</code>). The glob order determines the traversal order.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaML/MLDatasets.jl/blob/34b0482e4d1a71623645f7ff67eb36b995c269fa/src/containers/filedataset.jl#L12-L19">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="MLDatasets.CachedDataset" href="#MLDatasets.CachedDataset"><code>MLDatasets.CachedDataset</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">CachedDataset(source, cachesize = numbobs(source))
+FileDataset([loadfn = FileIO.load,] dir, pattern = &quot;*&quot;, depth = 4)</code></pre><p>Wrap a set of file <code>paths</code> as a dataset (traversed in the same order as <code>paths</code>). Alternatively, specify a <code>dir</code> and collect all paths that match a glob <code>pattern</code> (recursively globbing by <code>depth</code>). The glob order determines the traversal order.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaML/MLDatasets.jl/blob/556529ce3f95de0e033048a502832dbe35bc7c63/src/containers/filedataset.jl#L12-L19">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="MLDatasets.CachedDataset" href="#MLDatasets.CachedDataset"><code>MLDatasets.CachedDataset</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">CachedDataset(source, cachesize = numbobs(source))
 CachedDataset(source, cacheidx = 1:numbobs(source))
-CachedDataset(source, cacheidx, cache)</code></pre><p>Wrap a <code>source</code> data container and cache <code>cachesize</code> samples in memory. This can be useful for improving read speeds when <code>source</code> is a lazy data container, but your system memory is large enough to store a sizeable chunk of it.</p><p>By default the observation indices <code>1:cachesize</code> are cached. You can manually pass in a set of <code>cacheidx</code> as well.</p><p>See also <a href="#MLDatasets.make_cache"><code>make_cache</code></a> for customizing the default cache creation for <code>source</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaML/MLDatasets.jl/blob/34b0482e4d1a71623645f7ff67eb36b995c269fa/src/containers/cacheddataset.jl#L9-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="MLDatasets.make_cache" href="#MLDatasets.make_cache"><code>MLDatasets.make_cache</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">make_cache(source, cacheidx)</code></pre><p>Return a in-memory copy of <code>source</code> at observation indices <code>cacheidx</code>. Defaults to <code>getobs(source, cacheidx)</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaML/MLDatasets.jl/blob/34b0482e4d1a71623645f7ff67eb36b995c269fa/src/containers/cacheddataset.jl#L1-L6">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../datasets/vision/">« Vision</a><a class="docs-footer-nextpage" href="../../LICENSE/">LICENSE »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Saturday 14 September 2024 13:54">Saturday 14 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+CachedDataset(source, cacheidx, cache)</code></pre><p>Wrap a <code>source</code> data container and cache <code>cachesize</code> samples in memory. This can be useful for improving read speeds when <code>source</code> is a lazy data container, but your system memory is large enough to store a sizeable chunk of it.</p><p>By default the observation indices <code>1:cachesize</code> are cached. You can manually pass in a set of <code>cacheidx</code> as well.</p><p>See also <a href="#MLDatasets.make_cache"><code>make_cache</code></a> for customizing the default cache creation for <code>source</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaML/MLDatasets.jl/blob/556529ce3f95de0e033048a502832dbe35bc7c63/src/containers/cacheddataset.jl#L9-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="MLDatasets.make_cache" href="#MLDatasets.make_cache"><code>MLDatasets.make_cache</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">make_cache(source, cacheidx)</code></pre><p>Return a in-memory copy of <code>source</code> at observation indices <code>cacheidx</code>. Defaults to <code>getobs(source, cacheidx)</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaML/MLDatasets.jl/blob/556529ce3f95de0e033048a502832dbe35bc7c63/src/containers/cacheddataset.jl#L1-L6">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../datasets/vision/">« Vision</a><a class="docs-footer-nextpage" href="../../LICENSE/">LICENSE »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 16 September 2024 16:29">Monday 16 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>