Skip to content

Commit

Permalink
build based on a6164ad
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Aug 3, 2024
1 parent 6cc2052 commit 20cd2b5
Show file tree
Hide file tree
Showing 29 changed files with 4,750 additions and 0 deletions.
1 change: 1 addition & 0 deletions previews/PR341/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-08-03T20:40:44","documenter_version":"1.5.0"}}
51 changes: 51 additions & 0 deletions previews/PR341/api/data/index.html
View file

Large diffs are not rendered by default.

13 changes: 13 additions & 0 deletions previews/PR341/api/dataset/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Dataset · ArviZ.jl</title><meta name="title" content="Dataset · ArviZ.jl"/><meta property="og:title" content="Dataset · ArviZ.jl"/><meta property="twitter:title" content="Dataset · ArviZ.jl"/><meta name="description" content="Documentation for ArviZ.jl."/><meta property="og:description" content="Documentation for ArviZ.jl."/><meta property="twitter:description" content="Documentation for ArviZ.jl."/><meta property="og:url" content="stable/api/dataset/"/><meta property="twitter:url" content="stable/api/dataset/"/><link rel="canonical" href="stable/api/dataset/"/><script async src="https://www.googletagmanager.com/gtag/js?id=G-W1G68W77YV"></script><script> window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-W1G68W77YV', {'page_path': location.pathname + location.search + location.hash});
</script><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"/><link href="../../assets/custom.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../../"><img class="docs-light-only" src="../../assets/logo.png" alt="ArviZ.jl logo"/><img class="docs-dark-only" src="../../assets/logo-dark.png" alt="ArviZ.jl logo"/></a><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">Getting Started</span><ul><li><a class="tocitem" href="../../quickstart/">Quickstart</a></li><li><a class="tocitem" href="../../working_with_inference_data/">Working with <code>InferenceData</code></a></li><li><a class="tocitem" href="../../creating_custom_plots/">Creating custom plots</a></li></ul></li><li><span class="tocitem">API</span><ul><li><a class="tocitem" href="../stats/">Stats</a></li><li><a class="tocitem" href="../diagnostics/">Diagnostics</a></li><li><a class="tocitem" href="../data/">Data</a></li><li><input class="collapse-toggle" id="menuitem-3-5" type="checkbox" checked/><label class="tocitem" for="menuitem-3-5"><span class="docs-label">InferenceObjects</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../inference_data/">InferenceData</a></li><li class="is-active"><a class="tocitem" href>Dataset</a><ul class="internal"><li><a class="tocitem" href="#Type-definition"><span>Type definition</span></a></li><li><a class="tocitem" href="#General-conversion"><span>General conversion</span></a></li><li><a class="tocitem" href="#DimensionalData"><span>DimensionalData</span></a></li><li><a class="tocitem" href="#Tables-inteface"><span>Tables inteface</span></a></li></ul></li></ul></li></ul></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">API</a></li><li><a class="is-disabled">InferenceObjects</a></li><li class="is-active"><a href>Dataset</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Dataset</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/arviz-devs/ArviZ.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/arviz-devs/ArviZ.jl/blob/main/docs/src/api/dataset.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-api"><a class="docs-heading-anchor" href="#dataset-api">Dataset</a><a id="dataset-api-1"></a><a class="docs-heading-anchor-permalink" href="#dataset-api" title="Permalink"></a></h1><ul><li><a href="#InferenceObjects.Dataset"><code>InferenceObjects.Dataset</code></a></li><li><a href="#InferenceObjects.convert_to_dataset"><code>InferenceObjects.convert_to_dataset</code></a></li><li><a href="#InferenceObjects.namedtuple_to_dataset"><code>InferenceObjects.namedtuple_to_dataset</code></a></li></ul><h2 id="Type-definition"><a class="docs-heading-anchor" href="#Type-definition">Type definition</a><a id="Type-definition-1"></a><a class="docs-heading-anchor-permalink" href="#Type-definition" title="Permalink"></a></h2><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="InferenceObjects.Dataset" href="#InferenceObjects.Dataset"><code>InferenceObjects.Dataset</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Dataset{L} &lt;: DimensionalData.AbstractDimStack{L}</code></pre><p>Container of dimensional arrays sharing some dimensions.</p><p>This type is an <a href="https://rafaqz.github.io/DimensionalData.jl/stable/reference/#DimensionalData.AbstractDimStack"><code>DimensionalData.AbstractDimStack</code></a> that implements the same interface as <code>DimensionalData.DimStack</code> and has identical usage.</p><p>When a <code>Dataset</code> is passed to Python, it is converted to an <code>xarray.Dataset</code> without copying the data. That is, the Python object shares the same memory as the Julia object. However, if an <code>xarray.Dataset</code> is passed to Julia, its data must be copied.</p><p><strong>Constructors</strong></p><pre><code class="nohighlight hljs">Dataset(data::DimensionalData.AbstractDimArray...)
Dataset(data::Tuple{Vararg{&lt;:DimensionalData.AbstractDimArray}})
Dataset(data::NamedTuple{Keys,Vararg{&lt;:DimensionalData.AbstractDimArray}})
Dataset(
data::NamedTuple,
dims::Tuple{Vararg{DimensionalData.Dimension}};
metadata=DimensionalData.NoMetadata(),
)</code></pre><p>In most cases, use <a href="#InferenceObjects.convert_to_dataset"><code>convert_to_dataset</code></a> to create a <code>Dataset</code> instead of directly using a constructor.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/arviz-devs/InferenceObjects.jl/blob/v0.3.16/src/dataset.jl#L1-L27">source</a></section></article><h2 id="General-conversion"><a class="docs-heading-anchor" href="#General-conversion">General conversion</a><a id="General-conversion-1"></a><a class="docs-heading-anchor-permalink" href="#General-conversion" title="Permalink"></a></h2><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="InferenceObjects.convert_to_dataset" href="#InferenceObjects.convert_to_dataset"><code>InferenceObjects.convert_to_dataset</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">convert_to_dataset(obj; group = :posterior, kwargs...) -&gt; Dataset</code></pre><p>Convert a supported object to a <code>Dataset</code>.</p><p>In most cases, this function calls <a href="../inference_data/#InferenceObjects.convert_to_inference_data"><code>convert_to_inference_data</code></a> and returns the corresponding <code>group</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/arviz-devs/InferenceObjects.jl/blob/v0.3.16/src/convert_dataset.jl#L4-L11">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="InferenceObjects.namedtuple_to_dataset" href="#InferenceObjects.namedtuple_to_dataset"><code>InferenceObjects.namedtuple_to_dataset</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">namedtuple_to_dataset(data; kwargs...) -&gt; Dataset</code></pre><p>Convert <code>NamedTuple</code> mapping variable names to arrays to a <a href="#InferenceObjects.Dataset"><code>Dataset</code></a>.</p><p>Any non-array values will be converted to a 0-dimensional array.</p><p><strong>Keywords</strong></p><ul><li><code>attrs::AbstractDict{&lt;:AbstractString}</code>: a collection of metadata to attach to the dataset, in addition to defaults. Values should be JSON serializable.</li><li><code>library::Union{String,Module}</code>: library used for performing inference. Will be attached to the <code>attrs</code> metadata.</li><li><code>dims</code>: a collection mapping variable names to collections of objects containing dimension names. Acceptable such objects are:<ul><li><code>Symbol</code>: dimension name</li><li><code>Type{&lt;:DimensionsionalData.Dimension}</code>: dimension type</li><li><code>DimensionsionalData.Dimension</code>: dimension, potentially with indices</li><li><code>Nothing</code>: no dimension name provided, dimension name is automatically generated</li></ul></li><li><code>coords</code>: a collection indexable by dimension name specifying the indices of the given dimension. If indices for a dimension in <code>dims</code> are provided, they are used even if the dimension contains its own indices. If a dimension is missing, its indices are automatically generated.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/arviz-devs/InferenceObjects.jl/blob/v0.3.16/src/dataset.jl#L46-L69">source</a></section></article><h2 id="DimensionalData"><a class="docs-heading-anchor" href="#DimensionalData">DimensionalData</a><a id="DimensionalData-1"></a><a class="docs-heading-anchor-permalink" href="#DimensionalData" title="Permalink"></a></h2><p>As a <code>DimensionalData.AbstractDimStack</code>, <code>Dataset</code> also implements the <code>AbstractDimStack</code> API and can be used like a <code>DimStack</code>. See <a href="https://rafaqz.github.io/DimensionalData.jl/stable/">DimensionalData&#39;s documentation</a> for example usage.</p><h2 id="Tables-inteface"><a class="docs-heading-anchor" href="#Tables-inteface">Tables inteface</a><a id="Tables-inteface-1"></a><a class="docs-heading-anchor-permalink" href="#Tables-inteface" title="Permalink"></a></h2><p><code>Dataset</code> implements the <a href="https://github.com/JuliaData/Tables.jl">Tables</a> interface. This allows <code>Dataset</code>s to be used as sources for any function that can accept a table. For example, it&#39;s straightforward to:</p><ul><li>write to CSV with CSV.jl</li><li>flatten to a DataFrame with DataFrames.jl</li><li>plot with StatsPlots.jl</li><li>plot with AlgebraOfGraphics.jl</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../inference_data/">« InferenceData</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.5.0 on <span class="colophon-date" title="Saturday 3 August 2024 20:40">Saturday 3 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 20cd2b5

Please sign in to comment.