Skip to content

Commit b2d2028

Browse files
author
Documenter.jl
committed
build based on f5aa742
1 parent 1648da6 commit b2d2028

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+7818
-2
lines changed

stable

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
v0.4.2
1+
v0.5.0

v0.5

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v0.5.0

v0.5.0/.documenter-siteinfo.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"documenter":{"julia_version":"1.11.4","generation_timestamp":"2025-03-25T17:56:21","documenter_version":"1.9.0"}}

v0.5.0/api/internal/index.html

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<!DOCTYPE html>
2+
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Internal · TensorInference.jl</title><meta name="title" content="Internal · TensorInference.jl"/><meta property="og:title" content="Internal · TensorInference.jl"/><meta property="twitter:title" content="Internal · TensorInference.jl"/><meta name="description" content="Documentation for TensorInference.jl."/><meta property="og:description" content="Documentation for TensorInference.jl."/><meta property="twitter:description" content="Documentation for TensorInference.jl."/><meta property="og:url" content="https://TensorBFS.github.io/TensorInference.jl/api/internal/"/><meta property="twitter:url" content="https://TensorBFS.github.io/TensorInference.jl/api/internal/"/><link rel="canonical" href="https://TensorBFS.github.io/TensorInference.jl/api/internal/"/><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.svg" alt="TensorInference.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../../">TensorInference.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">Background</span><ul><li><a class="tocitem" href="../../probabilistic-inference/">Probabilistic Inference</a></li><li><a class="tocitem" href="../../tensor-networks/">Tensor Networks</a></li><li><a class="tocitem" href="../../uai-file-formats/">UAI file formats</a></li></ul></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-network/main/">Asia Network</a></li><li><a class="tocitem" href="../../generated/hard-core-lattice-gas/main/">Hard-core Lattice Gas</a></li></ul></li><li><a class="tocitem" href="../../performance-evaluation/">Performance evaluation</a></li><li><a class="tocitem" href="../../generated/performance-tips/">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><li><a class="tocitem" href="../../contributing/">Contributing</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">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-navbar-link" href="https://github.com/TensorBFS/TensorInference.jl/blob/main/docs/src/api/internal.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="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_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-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="TensorInference.Factor" href="#TensorInference.Factor"><code>TensorInference.Factor</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">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/f5aa742e4acd09bd561012fe72c893e8f77941e3/src/Core.jl#L1">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="TensorInference.Samples" href="#TensorInference.Samples"><code>TensorInference.Samples</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">struct Samples{L} &lt;: AbstractVector{SubArray{Float64, 1, Matrix{Float64}, Tuple{Base.Slice{Base.OneTo{Int64}}, Int64}, true}}</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></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.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/TensorBFS/TensorInference.jl/blob/f5aa742e4acd09bd561012fe72c893e8f77941e3/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-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><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><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">backward_tropical!(
3+
ixs,
4+
xs::Tuple,
5+
iy,
6+
y,
7+
ymask,
8+
size_dict
9+
) -&gt; Vector{Any}
10+
</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/f5aa742e4acd09bd561012fe72c893e8f77941e3/src/map.jl#L9">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="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><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">parse_mar_solution_file(
11+
rawlines::Vector{String};
12+
factor_eltype
13+
) -&gt; Vector{Vector{Float64}}
14+
</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/f5aa742e4acd09bd561012fe72c893e8f77941e3/src/utils.jl#L124">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="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><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">read_query_file(
15+
query_filepath::AbstractString
16+
) -&gt; Vector{Int64}
17+
</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/f5aa742e4acd09bd561012fe72c893e8f77941e3/src/utils.jl#L96">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="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><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">rescale_array(tensor::AbstractArray{T}) -&gt; RescaledArray
18+
</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/f5aa742e4acd09bd561012fe72c893e8f77941e3/src/RescaledArray.jl#L20">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../public/">« Public</a><a class="docs-footer-nextpage" href="../../contributing/">Contributing »</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.9.0 on <span class="colophon-date" title="Tuesday 25 March 2025 17:56">Tuesday 25 March 2025</span>. Using Julia version 1.11.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)