-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Oct 15, 2023
1 parent
d765b4b
commit b3cabf7
Showing
4 changed files
with
4 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| {"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-13T09:23:39","documenter_version":"1.1.1"}} | ||
| {"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-15T17:42:45","documenter_version":"1.1.1"}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Implementer guide · AbstractDifferentiation.jl</title><meta name="title" content="Implementer guide · AbstractDifferentiation.jl"/><meta property="og:title" content="Implementer guide · AbstractDifferentiation.jl"/><meta property="twitter:title" content="Implementer guide · AbstractDifferentiation.jl"/><meta name="description" content="Documentation for AbstractDifferentiation.jl."/><meta property="og:description" content="Documentation for AbstractDifferentiation.jl."/><meta property="twitter:description" content="Documentation for AbstractDifferentiation.jl."/><meta property="og:url" content="https://JuliaDiff.github.io/AbstractDifferentiation.jl/implementer_guide/"/><meta property="twitter:url" content="https://JuliaDiff.github.io/AbstractDifferentiation.jl/implementer_guide/"/><link rel="canonical" href="https://JuliaDiff.github.io/AbstractDifferentiation.jl/implementer_guide/"/><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/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></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">AbstractDifferentiation.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><a class="tocitem" href="../user_guide/">User guide</a></li><li class="is-active"><a class="tocitem" href>Implementer guide</a><ul class="internal"><li><a class="tocitem" href="#The-macro-@primitive"><span>The macro <code>@primitive</code></span></a></li><li><a class="tocitem" href="#Function-dependency-graph"><span>Function dependency graph</span></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"><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 class="is-active"><a href>Implementer guide</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Implementer guide</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaDiff/AbstractDifferentiation.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/JuliaDiff/AbstractDifferentiation.jl/blob/master/docs/src/implementer_guide.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="Implementer-guide"><a class="docs-heading-anchor" href="#Implementer-guide">Implementer guide</a><a id="Implementer-guide-1"></a><a class="docs-heading-anchor-permalink" href="#Implementer-guide" title="Permalink"></a></h1><div class="admonition is-warning"><header class="admonition-header">Work in progress</header><div class="admonition-body"><p>Come back later!</p></div></div><h2 id="The-macro-@primitive"><a class="docs-heading-anchor" href="#The-macro-@primitive">The macro <code>@primitive</code></a><a id="The-macro-@primitive-1"></a><a class="docs-heading-anchor-permalink" href="#The-macro-@primitive" title="Permalink"></a></h2><p>To implement the <code>AbstractDifferentiation</code> interface for your backend, you only <em>need</em> to provide a "primitive" from which the rest of the functions can be deduced. However, for performance reasons, you <em>can</em> implement more of the interface to make certain calls faster.</p><p>At the moment, the only primitives supported are <code>AD.pushforward_function</code> and <code>AD.value_and_pullback_function</code>. The <code>AD.@primitive</code> macro uses the provided function to implement <code>AD.jacobian</code>, and all the other functions follow.</p><pre><code class="language-julia hljs">AD.@primitive function AD.myprimitive(ab::MyBackend, f, xs...) | ||
| # write your code here | ||
| end</code></pre><p>See the backend-specific extensions in the <code>ext/</code> folder of the repository for example implementations.</p><h2 id="Function-dependency-graph"><a class="docs-heading-anchor" href="#Function-dependency-graph">Function dependency graph</a><a id="Function-dependency-graph-1"></a><a class="docs-heading-anchor-permalink" href="#Function-dependency-graph" title="Permalink"></a></h2><p>These details are not part of the public API and are expected to change. They are just listed here to help readers figure out the code structure:</p><ul><li><code>jacobian</code> has no default implementation</li><li><code>derivative</code> calls <code>jacobian</code></li><li><code>gradient</code> calls <code>jacobian</code></li><li><code>hessian</code> calls <code>jacobian</code> and <code>gradient</code></li><li><code>value_and_jacobian</code> calls <code>jacobian</code></li><li><code>value_and_derivative</code> calls <code>value_and_jacobian</code></li><li><code>value_and_gradient</code> calls <code>value_and_jacobian</code></li><li><code>value_and_hessian</code> calls <code>jacobian</code> and <code>gradient</code></li><li><code>value_gradient_and_hessian</code> calls <code>value_and_jacobian</code> and <code>gradient</code></li><li><code>pushforward_function</code> calls <code>jacobian</code></li><li><code>value_and_pushforward_function</code> calls <code>pushforward_function</code></li><li><code>pullback_function</code> calls <code>value_and_pullback_function</code></li><li><code>value_and_pullback_function</code> calls <code>gradient</code></li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../user_guide/">« User guide</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.1 on <span class="colophon-date" title="Friday 13 October 2023 09:23">Friday 13 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> | ||
| end</code></pre><p>See the backend-specific extensions in the <code>ext/</code> folder of the repository for example implementations.</p><h2 id="Function-dependency-graph"><a class="docs-heading-anchor" href="#Function-dependency-graph">Function dependency graph</a><a id="Function-dependency-graph-1"></a><a class="docs-heading-anchor-permalink" href="#Function-dependency-graph" title="Permalink"></a></h2><p>These details are not part of the public API and are expected to change. They are just listed here to help readers figure out the code structure:</p><ul><li><code>jacobian</code> has no default implementation</li><li><code>derivative</code> calls <code>jacobian</code></li><li><code>gradient</code> calls <code>jacobian</code></li><li><code>hessian</code> calls <code>jacobian</code> and <code>gradient</code></li><li><code>value_and_jacobian</code> calls <code>jacobian</code></li><li><code>value_and_derivative</code> calls <code>value_and_jacobian</code></li><li><code>value_and_gradient</code> calls <code>value_and_jacobian</code></li><li><code>value_and_hessian</code> calls <code>jacobian</code> and <code>gradient</code></li><li><code>value_gradient_and_hessian</code> calls <code>value_and_jacobian</code> and <code>gradient</code></li><li><code>pushforward_function</code> calls <code>jacobian</code></li><li><code>value_and_pushforward_function</code> calls <code>pushforward_function</code></li><li><code>pullback_function</code> calls <code>value_and_pullback_function</code></li><li><code>value_and_pullback_function</code> calls <code>gradient</code></li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../user_guide/">« User guide</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.1 on <span class="colophon-date" title="Sunday 15 October 2023 17:42">Sunday 15 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.