Skip to content

Commit

Permalink
build based on 9f9957b
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Mar 26, 2024
1 parent 9400395 commit a783489
Show file tree
Hide file tree
Showing 11 changed files with 260 additions and 208 deletions.
47 changes: 27 additions & 20 deletions previews/PR1324/api/index.html
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions previews/PR1324/dev_docs/index.html
View file
Original file line number Diff line number Diff line change
@@ -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>For developers · Enzyme.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link rel="canonical" href="https://enzyme.mit.edu/julia/dev_docs/"/><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><script src="https://plausible.io/js/plausible.js" data-domain="enzyme.mit.edu" defer></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.svg" alt="Enzyme.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">Enzyme.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><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="../generated/box/">Box model</a></li><li><a class="tocitem" href="../generated/autodiff/">AutoDiff API</a></li><li><a class="tocitem" href="../generated/custom_rule/">Custom rules</a></li></ul></li><li><a class="tocitem" href="../api/">API</a></li><li><a class="tocitem" href="../pullbacks/">Implementing pullbacks</a></li><li class="is-active"><a class="tocitem" href>For developers</a><ul class="internal"><li><a class="tocitem" href="#Development-of-Enzyme-and-Enzyme.jl-together"><span>Development of Enzyme and Enzyme.jl together</span></a></li><li><a class="tocitem" href="#Building-Enzyme-against-Julia&#39;s-LLVM."><span>Building Enzyme against Julia&#39;s LLVM.</span></a></li></ul></li><li><a class="tocitem" href="../internal_api/">Internal API</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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>For developers</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>For developers</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/EnzymeAD/Enzyme.jl/blob/main/docs/src/dev_docs.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="Enzyme-developer-documentation"><a class="docs-heading-anchor" href="#Enzyme-developer-documentation">Enzyme developer documentation</a><a id="Enzyme-developer-documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Enzyme-developer-documentation" title="Permalink"></a></h1><h2 id="Development-of-Enzyme-and-Enzyme.jl-together"><a class="docs-heading-anchor" href="#Development-of-Enzyme-and-Enzyme.jl-together">Development of Enzyme and Enzyme.jl together</a><a id="Development-of-Enzyme-and-Enzyme.jl-together-1"></a><a class="docs-heading-anchor-permalink" href="#Development-of-Enzyme-and-Enzyme.jl-together" title="Permalink"></a></h2><p>Normally Enzyme.jl downloads and install Enzyme for the user automatically since Enzyme needs to be built against Julia bundeled LLVM. In case that you are making updates to Enzyme and want to test them against Enzyme.jl the instructions below should help you get started.</p><p>Start Julia in your development copy of Enzyme.jl</p><pre><code class="language-bash hljs">~/s/Enzyme (master)&gt; julia --project=.</code></pre><p>Then create a development copy of Enzyme_jll and activate it within.</p><pre><code class="language-julia-repl hljs">julia&gt; using Enzyme_jll
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>For developers · Enzyme.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link rel="canonical" href="https://enzyme.mit.edu/julia/dev_docs/"/><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><script src="https://plausible.io/js/plausible.js" data-domain="enzyme.mit.edu" defer></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.svg" alt="Enzyme.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">Enzyme.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><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="../generated/autodiff/">Basics</a></li><li><a class="tocitem" href="../generated/box/">Box model</a></li><li><a class="tocitem" href="../generated/custom_rule/">Custom rules</a></li></ul></li><li><a class="tocitem" href="../faq/">FAQ</a></li><li><a class="tocitem" href="../api/">API reference</a></li><li><span class="tocitem">Advanced</span><ul><li class="is-active"><a class="tocitem" href>For developers</a><ul class="internal"><li><a class="tocitem" href="#Development-of-Enzyme-and-Enzyme.jl-together"><span>Development of Enzyme and Enzyme.jl together</span></a></li><li><a class="tocitem" href="#Building-Enzyme-against-Julia&#39;s-LLVM."><span>Building Enzyme against Julia&#39;s LLVM.</span></a></li></ul></li><li><a class="tocitem" href="../internal_api/">Internal API</a></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">Advanced</a></li><li class="is-active"><a href>For developers</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>For developers</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/EnzymeAD/Enzyme.jl/blob/main/docs/src/dev_docs.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="Enzyme-developer-documentation"><a class="docs-heading-anchor" href="#Enzyme-developer-documentation">Enzyme developer documentation</a><a id="Enzyme-developer-documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Enzyme-developer-documentation" title="Permalink"></a></h1><h2 id="Development-of-Enzyme-and-Enzyme.jl-together"><a class="docs-heading-anchor" href="#Development-of-Enzyme-and-Enzyme.jl-together">Development of Enzyme and Enzyme.jl together</a><a id="Development-of-Enzyme-and-Enzyme.jl-together-1"></a><a class="docs-heading-anchor-permalink" href="#Development-of-Enzyme-and-Enzyme.jl-together" title="Permalink"></a></h2><p>Normally Enzyme.jl downloads and install Enzyme for the user automatically since Enzyme needs to be built against Julia bundeled LLVM. In case that you are making updates to Enzyme and want to test them against Enzyme.jl the instructions below should help you get started.</p><p>Start Julia in your development copy of Enzyme.jl</p><pre><code class="language-bash hljs">~/s/Enzyme (master)&gt; julia --project=.</code></pre><p>Then create a development copy of Enzyme_jll and activate it within.</p><pre><code class="language-julia-repl hljs">julia&gt; using Enzyme_jll
julia&gt; Enzyme_jll.dev_jll()
[ Info: Enzyme_jll dev&#39;ed out to ${JULIA_PKG_DEVDIR}/Enzyme_jll with pre-populated override directory
(Enzyme) pkg&gt; dev Enzyme_jll
Expand All @@ -11,4 +11,4 @@
julia -e &quot;using Pkg; pkg\&quot;add LLVM_full_jll@${LLVM_MAJOR_VER}\&quot;&quot;
LLVM_DIR=`julia -e &quot;using LLVM_full_jll; print(LLVM_full_jll.artifact_dir)&quot;`
echo &quot;LLVM_DIR=$LLVM_DIR&quot;
cmake ../enzyme/ -G Ninja -DENZYME_EXTERNAL_SHARED_LIB=ON -DLLVM_DIR=${LLVM_DIR} -DLLVM_EXTERNAL_LIT=${LLVM_DIR}/tools/lit/lit.py</code></pre><h3 id="Manual-build-of-Julia"><a class="docs-heading-anchor" href="#Manual-build-of-Julia">Manual build of Julia</a><a id="Manual-build-of-Julia-1"></a><a class="docs-heading-anchor-permalink" href="#Manual-build-of-Julia" title="Permalink"></a></h3><pre><code class="nohighlight hljs">cmake ../enzyme/ -G Ninja -DENZYME_EXTERNAL_SHARED_LIB=ON -DLLVM_DIR=${PATH_TO_BUILDDIR_OF_JULIA}/usr/lib/cmake/llvm/</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../pullbacks/">« Implementing pullbacks</a><a class="docs-footer-nextpage" href="../internal_api/">Internal API »</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="Tuesday 5 March 2024 03:36">Tuesday 5 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
cmake ../enzyme/ -G Ninja -DENZYME_EXTERNAL_SHARED_LIB=ON -DLLVM_DIR=${LLVM_DIR} -DLLVM_EXTERNAL_LIT=${LLVM_DIR}/tools/lit/lit.py</code></pre><h3 id="Manual-build-of-Julia"><a class="docs-heading-anchor" href="#Manual-build-of-Julia">Manual build of Julia</a><a id="Manual-build-of-Julia-1"></a><a class="docs-heading-anchor-permalink" href="#Manual-build-of-Julia" title="Permalink"></a></h3><pre><code class="nohighlight hljs">cmake ../enzyme/ -G Ninja -DENZYME_EXTERNAL_SHARED_LIB=ON -DLLVM_DIR=${PATH_TO_BUILDDIR_OF_JULIA}/usr/lib/cmake/llvm/</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../api/">« API reference</a><a class="docs-footer-nextpage" href="../internal_api/">Internal API »</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="Tuesday 26 March 2024 14:39">Tuesday 26 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit a783489

Please sign in to comment.