build based on a3e0926

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-08T17:43:27","documenter_version":"1.7.0"}}
+{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-14T19:34:23","documenter_version":"1.8.0"}}

dev/CONTRIBUTING/index.html

@@ -5,4 +5,4 @@
 julia +release~x64 test/runtests.jl --overwrite</code></pre><p>The test suite takes a while to run. You can filter to only run a selection of test suites by specifying them as positional arguments, e.g.</p><pre><code class="nohighlight hljs">./test/runtests.jl constructors conversions representation</code></pre><p>This information is summarized with <code>./test/runtests.jl --help</code></p><h3 id="Python-test-suite"><a class="docs-heading-anchor" href="#Python-test-suite">Python test suite</a><a id="Python-test-suite-1"></a><a class="docs-heading-anchor-permalink" href="#Python-test-suite" title="Permalink"></a></h3><p><a href="https://github.com/finch-tensor/finch-tensor-python">finch-tensor-python</a> contains a separate Array API compatible test suite written in Python. It requires Python 3.10 or later and Poetry installed.</p><p>It can be run with:</p><pre><code class="language-sh hljs">git clone https://github.com/finch-tensor/finch-tensor-python.git
 cd finch-tensor-python
 poetry install --with test
-FINCH_REPO_PATH=&lt;PATH_TO_FINCH_REPO&gt; poetry run pytest tests/</code></pre><h2 id="Benchmarking"><a class="docs-heading-anchor" href="#Benchmarking">Benchmarking</a><a id="Benchmarking-1"></a><a class="docs-heading-anchor-permalink" href="#Benchmarking" title="Permalink"></a></h2><p>The Finch test suite includes a benchmarking script that measures Finch performance on a variety of kernels. It also includes some scripts to help compare Finch performance on the feature branch to the main branch. To run the benchmarking script, run <code>./benchmarks/runbenchmarks.jl</code>. To run the comparison script, run <code>./benchmarks/runjudge.jl</code>. Both scripts take a while to run and generate a report at the end.</p><h2 id="Documentation"><a class="docs-heading-anchor" href="#Documentation">Documentation</a><a id="Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Documentation" title="Permalink"></a></h2><p>The <code>/docs</code> directory includes Finch documentation in <code>/src</code>, and a built website in <code>/build</code>. You can build the website with <code>./docs/make.jl</code>. You can run doctests with <code>./docs/test.jl</code>, and fix doctests with <code>./docs/fix.jl</code>, though both are included as part of the test suite.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../reference/internals/finch_logic/">« Finch Logic</a><a class="docs-footer-nextpage" href="../appendices/directory_structure/">Directory Structure »</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="Friday 8 November 2024 17:43">Friday 8 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+FINCH_REPO_PATH=&lt;PATH_TO_FINCH_REPO&gt; poetry run pytest tests/</code></pre><h2 id="Benchmarking"><a class="docs-heading-anchor" href="#Benchmarking">Benchmarking</a><a id="Benchmarking-1"></a><a class="docs-heading-anchor-permalink" href="#Benchmarking" title="Permalink"></a></h2><p>The Finch test suite includes a benchmarking script that measures Finch performance on a variety of kernels. It also includes some scripts to help compare Finch performance on the feature branch to the main branch. To run the benchmarking script, run <code>./benchmarks/runbenchmarks.jl</code>. To run the comparison script, run <code>./benchmarks/runjudge.jl</code>. Both scripts take a while to run and generate a report at the end.</p><h2 id="Documentation"><a class="docs-heading-anchor" href="#Documentation">Documentation</a><a id="Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Documentation" title="Permalink"></a></h2><p>The <code>/docs</code> directory includes Finch documentation in <code>/src</code>, and a built website in <code>/build</code>. You can build the website with <code>./docs/make.jl</code>. You can run doctests with <code>./docs/test.jl</code>, and fix doctests with <code>./docs/fix.jl</code>, though both are included as part of the test suite.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../reference/internals/finch_logic/">« Finch Logic</a><a class="docs-footer-nextpage" href="../appendices/directory_structure/">Directory Structure »</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.8.0 on <span class="colophon-date" title="Thursday 14 November 2024 19:34">Thursday 14 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/appendices/directory_structure/index.html

@@ -57,4 +57,4 @@
 ├── [Manifest.toml]            # local listing of installed dependencies (don't commit this)
 ├── LICENSE
 ├── CONTRIBUTING.md
-└── README.md</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../CONTRIBUTING/">« Community and Contributions</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="Friday 8 November 2024 17:43">Friday 8 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+└── README.md</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../CONTRIBUTING/">« Community and Contributions</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.8.0 on <span class="colophon-date" title="Thursday 14 November 2024 19:34">Thursday 14 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>