Skip to content

Commit

Permalink
Update inline documents (#678)
Browse files Browse the repository at this point in the history
Update unfinished inline documents for functions
  • Loading branch information
jzstark authored Sep 16, 2024
1 parent 08375ec commit 5ff8f68
Show file tree
Hide file tree
Showing 95 changed files with 2,318 additions and 813 deletions.

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/owl-base/Owl_algodiff_core/Make/index.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/owl-base/Owl_algodiff_generic/Make/index.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Device (owl-base.Owl_computation_cpu_engine.Make_Nested.Graph.Optimiser.Operator.Symbol.Shape.Type.Device)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../../../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../../../../../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../../../../../../../../../index.html">owl-base</a> &#x00BB; <a href="../../../../../../../../index.html">Owl_computation_cpu_engine</a> &#x00BB; <a href="../../../../../../../index.html">Make_Nested</a> &#x00BB; <a href="../../../../../../index.html">Graph</a> &#x00BB; <a href="../../../../../index.html">Optimiser</a> &#x00BB; <a href="../../../../index.html">Operator</a> &#x00BB; <a href="../../../index.html">Symbol</a> &#x00BB; <a href="../../index.html">Shape</a> &#x00BB; <a href="../index.html">Type</a> &#x00BB; Device</nav><header class="odoc-preamble"><h1>Module <code><span>Type.Device</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#type-definition">Type definition</a></li><li><a href="#core-functions">Core functions</a></li></ul></nav><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-A"><a href="#module-A" class="anchor"></a><code><span><span class="keyword">module</span> <a href="A/index.html">A</a></span><span> : <a href="../../../../../../../../../Owl_types_ndarray_mutable/module-type-Sig/index.html">Owl_types_ndarray_mutable.Sig</a></span></code></div></div><h6 id="type-definition"><a href="#type-definition" class="anchor"></a>Type definition</h6><div class="odoc-spec"><div class="spec type anchored" id="type-device"><a href="#type-device" class="anchor"></a><code><span><span class="keyword">type</span> device</span></code></div><div class="spec-doc"><p>TODO</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-value"><a href="#type-value" class="anchor"></a><code><span><span class="keyword">type</span> value</span></code></div><div class="spec-doc"><p>TODO</p></div></div><h6 id="core-functions"><a href="#core-functions" class="anchor"></a>Core functions</h6><div class="odoc-spec"><div class="spec value anchored" id="val-make_device"><a href="#val-make_device" class="anchor"></a><code><span><span class="keyword">val</span> make_device : <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-device">device</a></span></code></div><div class="spec-doc"><p>TODO</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-arr_to_value"><a href="#val-arr_to_value" class="anchor"></a><code><span><span class="keyword">val</span> arr_to_value : <span><a href="A/index.html#type-arr">A.arr</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-value">value</a></span></code></div><div class="spec-doc"><p>TODO</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-value_to_arr"><a href="#val-value_to_arr" class="anchor"></a><code><span><span class="keyword">val</span> value_to_arr : <span><a href="#type-value">value</a> <span class="arrow">&#45;&gt;</span></span> <a href="A/index.html#type-arr">A.arr</a></span></code></div><div class="spec-doc"><p>TODO</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-elt_to_value"><a href="#val-elt_to_value" class="anchor"></a><code><span><span class="keyword">val</span> elt_to_value : <span><a href="A/index.html#type-elt">A.elt</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-value">value</a></span></code></div><div class="spec-doc"><p>TODO</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-value_to_elt"><a href="#val-value_to_elt" class="anchor"></a><code><span><span class="keyword">val</span> value_to_elt : <span><a href="#type-value">value</a> <span class="arrow">&#45;&gt;</span></span> <a href="A/index.html#type-elt">A.elt</a></span></code></div><div class="spec-doc"><p>TODO</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-value_to_float"><a href="#val-value_to_float" class="anchor"></a><code><span><span class="keyword">val</span> value_to_float : <span><a href="#type-value">value</a> <span class="arrow">&#45;&gt;</span></span> float</span></code></div><div class="spec-doc"><p>TODO</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_arr"><a href="#val-is_arr" class="anchor"></a><code><span><span class="keyword">val</span> is_arr : <span><a href="#type-value">value</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p>TODO</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_elt"><a href="#val-is_elt" class="anchor"></a><code><span><span class="keyword">val</span> is_elt : <span><a href="#type-value">value</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p>TODO</p></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Device (owl-base.Owl_computation_cpu_engine.Make_Nested.Graph.Optimiser.Operator.Symbol.Shape.Type.Device)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../../../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../../../../../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../../../../../../../../../index.html">owl-base</a> &#x00BB; <a href="../../../../../../../../index.html">Owl_computation_cpu_engine</a> &#x00BB; <a href="../../../../../../../index.html">Make_Nested</a> &#x00BB; <a href="../../../../../../index.html">Graph</a> &#x00BB; <a href="../../../../../index.html">Optimiser</a> &#x00BB; <a href="../../../../index.html">Operator</a> &#x00BB; <a href="../../../index.html">Symbol</a> &#x00BB; <a href="../../index.html">Shape</a> &#x00BB; <a href="../index.html">Type</a> &#x00BB; Device</nav><header class="odoc-preamble"><h1>Module <code><span>Type.Device</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#type-definition">Type definition</a></li><li><a href="#core-functions">Core functions</a></li></ul></nav><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-A"><a href="#module-A" class="anchor"></a><code><span><span class="keyword">module</span> <a href="A/index.html">A</a></span><span> : <a href="../../../../../../../../../Owl_types_ndarray_mutable/module-type-Sig/index.html">Owl_types_ndarray_mutable.Sig</a></span></code></div></div><h6 id="type-definition"><a href="#type-definition" class="anchor"></a>Type definition</h6><div class="odoc-spec"><div class="spec type anchored" id="type-device"><a href="#type-device" class="anchor"></a><code><span><span class="keyword">type</span> device</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-value"><a href="#type-value" class="anchor"></a><code><span><span class="keyword">type</span> value</span></code></div></div><h6 id="core-functions"><a href="#core-functions" class="anchor"></a>Core functions</h6><div class="odoc-spec"><div class="spec value anchored" id="val-make_device"><a href="#val-make_device" class="anchor"></a><code><span><span class="keyword">val</span> make_device : <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-device">device</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-arr_to_value"><a href="#val-arr_to_value" class="anchor"></a><code><span><span class="keyword">val</span> arr_to_value : <span><a href="A/index.html#type-arr">A.arr</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-value">value</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-value_to_arr"><a href="#val-value_to_arr" class="anchor"></a><code><span><span class="keyword">val</span> value_to_arr : <span><a href="#type-value">value</a> <span class="arrow">&#45;&gt;</span></span> <a href="A/index.html#type-arr">A.arr</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-elt_to_value"><a href="#val-elt_to_value" class="anchor"></a><code><span><span class="keyword">val</span> elt_to_value : <span><a href="A/index.html#type-elt">A.elt</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-value">value</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-value_to_elt"><a href="#val-value_to_elt" class="anchor"></a><code><span><span class="keyword">val</span> value_to_elt : <span><a href="#type-value">value</a> <span class="arrow">&#45;&gt;</span></span> <a href="A/index.html#type-elt">A.elt</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-value_to_float"><a href="#val-value_to_float" class="anchor"></a><code><span><span class="keyword">val</span> value_to_float : <span><a href="#type-value">value</a> <span class="arrow">&#45;&gt;</span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_arr"><a href="#val-is_arr" class="anchor"></a><code><span><span class="keyword">val</span> is_arr : <span><a href="#type-value">value</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_elt"><a href="#val-is_elt" class="anchor"></a><code><span><span class="keyword">val</span> is_elt : <span><a href="#type-value">value</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div></div></body></html>
Loading

0 comments on commit 5ff8f68

Please sign in to comment.