Skip to content

Commit

Permalink
build based on b292dd4
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Aug 14, 2023
1 parent d768344 commit fbabb2e
Show file tree
Hide file tree
Showing 32 changed files with 4,096 additions and 3 deletions.
2 changes: 1 addition & 1 deletion stable
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v0.2.0
v0.2.1
2 changes: 1 addition & 1 deletion v0.2
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v0.2.0
v0.2.1
26 changes: 26 additions & 0 deletions v0.2.1/api/internal/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Internal · TensorInference.jl</title><script data-outdated-warner src="../../assets/warner.js"></script><link rel="canonical" href="https://TensorBFS.github.io/TensorInference.jl/api/internal/"/><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.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/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="../../siteinfo.js"></script><script src="../../../versions.js"></script><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.svg" alt="TensorInference.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../../">TensorInference.jl</a></span></div><form class="docs-search" action="../../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><a class="tocitem" href="../../background/">Background</a></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="../../examples-overview/">Overview</a></li><li><a class="tocitem" href="../../generated/asia/main/">Asia network</a></li></ul></li><li><a class="tocitem" href="../../uai-file-formats/">UAI file formats</a></li><li><a class="tocitem" href="../../generated/performance/">Performance tips</a></li><li><span class="tocitem">API</span><ul><li><a class="tocitem" href="../public/">Public</a></li><li class="is-active"><a class="tocitem" href>Internal</a><ul class="internal"><li><a class="tocitem" href="#Index"><span>Index</span></a></li><li><a class="tocitem" href="#internal_Types"><span>Types</span></a></li><li><a class="tocitem" href="#internal_Functions"><span>Functions</span></a></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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API</a></li><li class="is-active"><a href>Internal</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Internal</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/TensorBFS/TensorInference.jl/blob/main/docs/src/api/internal.md#" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Internal-API"><a class="docs-heading-anchor" href="#Internal-API">Internal API</a><a id="Internal-API-1"></a><a class="docs-heading-anchor-permalink" href="#Internal-API" title="Permalink"></a></h1><h2 id="Index"><a class="docs-heading-anchor" href="#Index">Index</a><a id="Index-1"></a><a class="docs-heading-anchor-permalink" href="#Index" title="Permalink"></a></h2><p><a href="#internal_Types">Types</a></p><ul><li><a href="#TensorInference.Factor"><code>TensorInference.Factor</code></a></li><li><a href="#TensorInference.Samples"><code>TensorInference.Samples</code></a></li></ul><p><a href="#internal_Functions">Functions</a></p><ul><li><a href="#TensorInference.backward_sampling!-Tuple{Any, Tuple, Any, Any, TensorInference.Samples, Any}"><code>TensorInference.backward_sampling!</code></a></li><li><a href="#TensorInference.backward_tropical-Tuple{Any, Tuple, Vararg{Any, 4}}"><code>TensorInference.backward_tropical</code></a></li><li><a href="#TensorInference.parse_mar_solution_file-Tuple{Vector{String}}"><code>TensorInference.parse_mar_solution_file</code></a></li><li><a href="#TensorInference.read_query_file-Tuple{AbstractString}"><code>TensorInference.read_query_file</code></a></li><li><a href="#TensorInference.rescale_array-Union{Tuple{AbstractArray{T}}, Tuple{T}} where T"><code>TensorInference.rescale_array</code></a></li></ul><h2 id="internal_Types"><a class="docs-heading-anchor" href="#internal_Types">Types</a><a id="internal_Types-1"></a><a class="docs-heading-anchor-permalink" href="#internal_Types" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="TensorInference.Factor" href="#TensorInference.Factor"><code>TensorInference.Factor</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct Factor{T, N}</code></pre><p><strong>Fields</strong></p><ul><li><code>vars</code></li><li><code>vals</code></li></ul><p>Encodes a discrete function over the set of variables <code>vars</code> that maps each instantiation of <code>vars</code> into a nonnegative number in <code>vals</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/TensorBFS/TensorInference.jl/blob/b292dd40fc104261660309c82667ac95487b1f73/src/Core.jl#L1">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="TensorInference.Samples" href="#TensorInference.Samples"><code>TensorInference.Samples</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct Samples{L}</code></pre><p><strong>Fields</strong></p><ul><li><p><code>samples::Matrix{Int64}</code></p></li><li><p><code>labels::Vector</code></p></li><li><p><code>setmask::BitVector</code></p></li></ul><p>The sampled configurations are stored in <code>samples</code>, which is a vector of vector. <code>labels</code> is a vector of variable names for labeling configurations. The <code>setmask</code> is an boolean indicator to denote whether the sampling process of a variable is complete.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/TensorBFS/TensorInference.jl/blob/b292dd40fc104261660309c82667ac95487b1f73/src/sampling.jl#L2">source</a></section></article><h2 id="internal_Functions"><a class="docs-heading-anchor" href="#internal_Functions">Functions</a><a id="internal_Functions-1"></a><a class="docs-heading-anchor-permalink" href="#internal_Functions" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="TensorInference.backward_sampling!-Tuple{Any, Tuple, Any, Any, TensorInference.Samples, Any}" href="#TensorInference.backward_sampling!-Tuple{Any, Tuple, Any, Any, TensorInference.Samples, Any}"><code>TensorInference.backward_sampling!</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">backward_sampling!(
ixs,
xs::Tuple,
iy,
y,
samples::TensorInference.Samples,
size_dict
) -&gt; TensorInference.Samples
</code></pre><p>The backward process for sampling configurations.</p><ul><li><code>ixs</code> and <code>xs</code> are labels and tensor data for input tensors,</li><li><code>iy</code> and <code>y</code> are labels and tensor data for the output tensor,</li><li><code>samples</code> is the samples generated for eliminated variables,</li><li><code>size_dict</code> is a key-value map from tensor label to dimension size.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/TensorBFS/TensorInference.jl/blob/b292dd40fc104261660309c82667ac95487b1f73/src/sampling.jl#L28">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="TensorInference.backward_tropical-Tuple{Any, Tuple, Vararg{Any, 4}}" href="#TensorInference.backward_tropical-Tuple{Any, Tuple, Vararg{Any, 4}}"><code>TensorInference.backward_tropical</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">backward_tropical(
ixs,
xs::Tuple,
iy,
y,
ymask,
size_dict
) -&gt; Vector{Any}
</code></pre><p>The backward rule for tropical einsum.</p><ul><li><code>ixs</code> and <code>xs</code> are labels and tensor data for input tensors,</li><li><code>iy</code> and <code>y</code> are labels and tensor data for the output tensor,</li><li><code>ymask</code> is the boolean mask for gradients,</li><li><code>size_dict</code> is a key-value map from tensor label to dimension size.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/TensorBFS/TensorInference.jl/blob/b292dd40fc104261660309c82667ac95487b1f73/src/map.jl#L9">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="TensorInference.parse_mar_solution_file-Tuple{Vector{String}}" href="#TensorInference.parse_mar_solution_file-Tuple{Vector{String}}"><code>TensorInference.parse_mar_solution_file</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">parse_mar_solution_file(
rawlines::Vector{String};
factor_eltype
) -&gt; Vector{Vector{Float64}}
</code></pre><p>Parse the solution marginals of all variables from the UAI MAR solution file. The order of the variables is the same as in the model definition.</p><p>The UAI file formats are defined in: https://uaicompetition.github.io/uci-2022/file-formats/</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/TensorBFS/TensorInference.jl/blob/b292dd40fc104261660309c82667ac95487b1f73/src/utils.jl#L124">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="TensorInference.read_query_file-Tuple{AbstractString}" href="#TensorInference.read_query_file-Tuple{AbstractString}"><code>TensorInference.read_query_file</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">read_query_file(
query_filepath::AbstractString
) -&gt; Vector{Int64}
</code></pre><p>Return the query variables in <code>query_filepath</code>. If the passed file path is an empty string, return an empty vector.</p><p>The UAI file formats are defined in: https://uaicompetition.github.io/uci-2022/file-formats/</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/TensorBFS/TensorInference.jl/blob/b292dd40fc104261660309c82667ac95487b1f73/src/utils.jl#L96">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="TensorInference.rescale_array-Union{Tuple{AbstractArray{T}}, Tuple{T}} where T" href="#TensorInference.rescale_array-Union{Tuple{AbstractArray{T}}, Tuple{T}} where T"><code>TensorInference.rescale_array</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">rescale_array(tensor::AbstractArray{T}) -&gt; RescaledArray
</code></pre><p>Returns a rescaled array that equivalent to the input tensor.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/TensorBFS/TensorInference.jl/blob/b292dd40fc104261660309c82667ac95487b1f73/src/RescaledArray.jl#L20">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../public/">« Public</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Monday 14 August 2023 09:25">Monday 14 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit fbabb2e

Please sign in to comment.