Skip to content

Commit

Permalink
editing doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@jzstark
jzstark committed Aug 30, 2024
1 parent a8f10e5 commit a839af0
Show file tree
Hide file tree
Showing 26 changed files with 363 additions and 231 deletions.
2 changes: 1 addition & 1 deletion docs/owl-base/Owl_algodiff_check/Make/argument-1-AD/index.html
View file

Large diffs are not rendered by default.

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

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/owl-base/Owl_algodiff_generic_sig/module-type-Sig/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/owl-base/Owl_computation_engine/Flatten/argument-1-Engine/index.html
View file
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>Engine (owl-base.Owl_computation_engine.Flatten.Engine)</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_engine</a> &#x00BB; <a href="../index.html">Flatten</a> &#x00BB; Engine</nav><header class="odoc-preamble"><h1>Parameter <code><span>Flatten.Engine</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#core-evaluation-functions-of-the-engine">Core evaluation functions of the engine</a></li></ul></nav><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Graph"><a href="#module-Graph" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Graph/index.html">Graph</a></span><span> : <a href="../../../Owl_computation_graph_sig/module-type-Sig/index.html">Owl_computation_graph_sig.Sig</a></span></code></div></div><h6 id="core-evaluation-functions-of-the-engine"><a href="#core-evaluation-functions-of-the-engine" class="anchor"></a>Core evaluation functions of the engine</h6><div class="odoc-spec"><div class="spec value anchored" id="val-eval_arr"><a href="#val-eval_arr" class="anchor"></a><code><span><span class="keyword">val</span> eval_arr : <span><span><a href="Graph/Optimiser/Operator/Symbol/Shape/Type/index.html#type-arr">Graph.Optimiser.Operator.Symbol.Shape.Type.arr</a> array</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>TODO</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-eval_elt"><a href="#val-eval_elt" class="anchor"></a><code><span><span class="keyword">val</span> eval_elt : <span><span><a href="Graph/Optimiser/Operator/Symbol/Shape/Type/index.html#type-elt">Graph.Optimiser.Operator.Symbol.Shape.Type.elt</a> array</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>TODO</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-eval_graph"><a href="#val-eval_graph" class="anchor"></a><code><span><span class="keyword">val</span> eval_graph : <span><a href="Graph/index.html#type-graph">Graph.graph</a> <span class="arrow">&#45;&gt;</span></span> unit</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>Engine (owl-base.Owl_computation_engine.Flatten.Engine)</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_engine</a> &#x00BB; <a href="../index.html">Flatten</a> &#x00BB; Engine</nav><header class="odoc-preamble"><h1>Parameter <code><span>Flatten.Engine</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#core-evaluation-functions-of-the-engine">Core evaluation functions of the engine</a></li></ul></nav><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Graph"><a href="#module-Graph" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Graph/index.html">Graph</a></span><span> : <a href="../../../Owl_computation_graph_sig/module-type-Sig/index.html">Owl_computation_graph_sig.Sig</a></span></code></div></div><h6 id="core-evaluation-functions-of-the-engine"><a href="#core-evaluation-functions-of-the-engine" class="anchor"></a>Core evaluation functions of the engine</h6><div class="odoc-spec"><div class="spec value anchored" id="val-eval_arr"><a href="#val-eval_arr" class="anchor"></a><code><span><span class="keyword">val</span> eval_arr : <span><span><a href="Graph/Optimiser/Operator/Symbol/Shape/Type/index.html#type-arr">Graph.Optimiser.Operator.Symbol.Shape.Type.arr</a> array</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Execute actual computation included in each CGraph element (of output type ndarray) in an array.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-eval_elt"><a href="#val-eval_elt" class="anchor"></a><code><span><span class="keyword">val</span> eval_elt : <span><span><a href="Graph/Optimiser/Operator/Symbol/Shape/Type/index.html#type-elt">Graph.Optimiser.Operator.Symbol.Shape.Type.elt</a> array</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Execute actual computation included in each CGraph element (of output type float) in an array.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-eval_graph"><a href="#val-eval_graph" class="anchor"></a><code><span><span class="keyword">val</span> eval_graph : <span><a href="Graph/index.html#type-graph">Graph.graph</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Execute actual computation of a computation graph.</p></div></div></div></body></html>
2 changes: 1 addition & 1 deletion docs/owl-base/Owl_computation_engine/Flatten/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Flatten (owl-base.Owl_computation_engine.Flatten)</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_engine</a> &#x00BB; Flatten</nav><header class="odoc-preamble"><h1>Module <code><span>Owl_computation_engine.Flatten</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-Engine"><a href="#argument-1-Engine" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-Engine/index.html">Engine</a></span><span> : <a href="../../Owl_types_computation_engine/module-type-Sig/index.html">Owl_types_computation_engine.Sig</a></span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">module</span> <span class="keyword">type</span> <span class="keyword">of</span> <span class="keyword">struct</span> <span class="keyword">include</span> <a href="argument-1-Engine/index.html">Engine</a> <span class="keyword">end</span></span></code></summary><div class="odoc-spec"><div class="spec module anchored" id="module-Graph"><a href="#module-Graph" class="anchor"></a><code><span><span class="keyword">module</span> Graph</span><span> = <a href="argument-1-Engine/Graph/index.html">Engine.Graph</a></span></code></div></div><h6 id="core-evaluation-functions-of-the-engine"><a href="#core-evaluation-functions-of-the-engine" class="anchor"></a>Core evaluation functions of the engine</h6><div class="odoc-spec"><div class="spec value anchored" id="val-eval_arr"><a href="#val-eval_arr" class="anchor"></a><code><span><span class="keyword">val</span> eval_arr : <span><span><a href="argument-1-Engine/Graph/Optimiser/Operator/Symbol/Shape/Type/index.html#type-arr">Graph.Optimiser.Operator.Symbol.Shape.Type.arr</a> array</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>TODO</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-eval_elt"><a href="#val-eval_elt" class="anchor"></a><code><span><span class="keyword">val</span> eval_elt : <span><span><a href="argument-1-Engine/Graph/Optimiser/Operator/Symbol/Shape/Type/index.html#type-elt">Graph.Optimiser.Operator.Symbol.Shape.Type.elt</a> array</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>TODO</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-eval_graph"><a href="#val-eval_graph" class="anchor"></a><code><span><span class="keyword">val</span> eval_graph : <span><a href="argument-1-Engine/Graph/index.html#type-graph">Graph.graph</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>TODO</p></div></div></details></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">module</span> <span class="keyword">type</span> <span class="keyword">of</span> <span class="keyword">struct</span> <span class="keyword">include</span> <a href="argument-1-Engine/Graph/index.html">Graph</a> <span class="keyword">end</span></span></code></summary><div class="odoc-spec"><div class="spec module anchored" id="module-Optimiser"><a href="#module-Optimiser" class="anchor"></a><code><span><span class="keyword">module</span> Optimiser</span><span> = <a href="argument-1-Engine/Graph/Optimiser/index.html">Graph.Optimiser</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-graph"><a href="#type-graph" class="anchor"></a><code><span><span class="keyword">type</span> graph</span><span> = <a href="argument-1-Engine/Graph/index.html#type-graph">Engine.Graph.graph</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-shape_or_value"><a href="#val-shape_or_value" class="anchor"></a><code><span><span class="keyword">val</span> shape_or_value : <span><a href="argument-1-Engine/Graph/Optimiser/Operator/Symbol/Shape/Type/index.html#type-t">Optimiser.Operator.Symbol.Shape.Type.t</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-graph_to_dot"><a href="#val-graph_to_dot" class="anchor"></a><code><span><span class="keyword">val</span> graph_to_dot : <span><a href="#type-graph">graph</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-graph_to_trace"><a href="#val-graph_to_trace" class="anchor"></a><code><span><span class="keyword">val</span> graph_to_trace : <span><a href="#type-graph">graph</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-save_graph"><a href="#val-save_graph" class="anchor"></a><code><span><span class="keyword">val</span> save_graph : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-load_graph"><a href="#val-load_graph" class="anchor"></a><code><span><span class="keyword">val</span> load_graph : <span>string <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span> * <span class="type-var">'b</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-collect_rvs"><a href="#val-collect_rvs" class="anchor"></a><code><span><span class="keyword">val</span> collect_rvs :
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Flatten (owl-base.Owl_computation_engine.Flatten)</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_engine</a> &#x00BB; Flatten</nav><header class="odoc-preamble"><h1>Module <code><span>Owl_computation_engine.Flatten</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-Engine"><a href="#argument-1-Engine" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-Engine/index.html">Engine</a></span><span> : <a href="../../Owl_types_computation_engine/module-type-Sig/index.html">Owl_types_computation_engine.Sig</a></span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">module</span> <span class="keyword">type</span> <span class="keyword">of</span> <span class="keyword">struct</span> <span class="keyword">include</span> <a href="argument-1-Engine/index.html">Engine</a> <span class="keyword">end</span></span></code></summary><div class="odoc-spec"><div class="spec module anchored" id="module-Graph"><a href="#module-Graph" class="anchor"></a><code><span><span class="keyword">module</span> Graph</span><span> = <a href="argument-1-Engine/Graph/index.html">Engine.Graph</a></span></code></div></div><h6 id="core-evaluation-functions-of-the-engine"><a href="#core-evaluation-functions-of-the-engine" class="anchor"></a>Core evaluation functions of the engine</h6><div class="odoc-spec"><div class="spec value anchored" id="val-eval_arr"><a href="#val-eval_arr" class="anchor"></a><code><span><span class="keyword">val</span> eval_arr : <span><span><a href="argument-1-Engine/Graph/Optimiser/Operator/Symbol/Shape/Type/index.html#type-arr">Graph.Optimiser.Operator.Symbol.Shape.Type.arr</a> array</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Execute actual computation included in each CGraph element (of output type ndarray) in an array.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-eval_elt"><a href="#val-eval_elt" class="anchor"></a><code><span><span class="keyword">val</span> eval_elt : <span><span><a href="argument-1-Engine/Graph/Optimiser/Operator/Symbol/Shape/Type/index.html#type-elt">Graph.Optimiser.Operator.Symbol.Shape.Type.elt</a> array</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Execute actual computation included in each CGraph element (of output type float) in an array.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-eval_graph"><a href="#val-eval_graph" class="anchor"></a><code><span><span class="keyword">val</span> eval_graph : <span><a href="argument-1-Engine/Graph/index.html#type-graph">Graph.graph</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Execute actual computation of a computation graph.</p></div></div></details></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">module</span> <span class="keyword">type</span> <span class="keyword">of</span> <span class="keyword">struct</span> <span class="keyword">include</span> <a href="argument-1-Engine/Graph/index.html">Graph</a> <span class="keyword">end</span></span></code></summary><div class="odoc-spec"><div class="spec module anchored" id="module-Optimiser"><a href="#module-Optimiser" class="anchor"></a><code><span><span class="keyword">module</span> Optimiser</span><span> = <a href="argument-1-Engine/Graph/Optimiser/index.html">Graph.Optimiser</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-graph"><a href="#type-graph" class="anchor"></a><code><span><span class="keyword">type</span> graph</span><span> = <a href="argument-1-Engine/Graph/index.html#type-graph">Engine.Graph.graph</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-shape_or_value"><a href="#val-shape_or_value" class="anchor"></a><code><span><span class="keyword">val</span> shape_or_value : <span><a href="argument-1-Engine/Graph/Optimiser/Operator/Symbol/Shape/Type/index.html#type-t">Optimiser.Operator.Symbol.Shape.Type.t</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-graph_to_dot"><a href="#val-graph_to_dot" class="anchor"></a><code><span><span class="keyword">val</span> graph_to_dot : <span><a href="#type-graph">graph</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-graph_to_trace"><a href="#val-graph_to_trace" class="anchor"></a><code><span><span class="keyword">val</span> graph_to_trace : <span><a href="#type-graph">graph</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-save_graph"><a href="#val-save_graph" class="anchor"></a><code><span><span class="keyword">val</span> save_graph : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-load_graph"><a href="#val-load_graph" class="anchor"></a><code><span><span class="keyword">val</span> load_graph : <span>string <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span> * <span class="type-var">'b</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-collect_rvs"><a href="#val-collect_rvs" class="anchor"></a><code><span><span class="keyword">val</span> collect_rvs :
<span><span><span><a href="argument-1-Engine/Graph/Optimiser/Operator/Symbol/Shape/Type/index.html#type-attr">Optimiser.Operator.Symbol.Shape.Type.attr</a> <a href="../../Owl_graph/index.html#type-node">Owl_graph.node</a></span> array</span> <span class="arrow">&#45;&gt;</span></span>
<span><span><a href="argument-1-Engine/Graph/Optimiser/Operator/Symbol/Shape/Type/index.html#type-attr">Optimiser.Operator.Symbol.Shape.Type.attr</a> <a href="../../Owl_graph/index.html#type-node">Owl_graph.node</a></span> array</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-invalidate_rvs"><a href="#val-invalidate_rvs" class="anchor"></a><code><span><span class="keyword">val</span> invalidate_rvs : <span><a href="#type-graph">graph</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make_graph"><a href="#val-make_graph" class="anchor"></a><code><span><span class="keyword">val</span> make_graph :
<span><span class="label">input</span>:<span><span><a href="argument-1-Engine/Graph/Optimiser/Operator/Symbol/Shape/Type/index.html#type-attr">Optimiser.Operator.Symbol.Shape.Type.attr</a> <a href="../../Owl_graph/index.html#type-node">Owl_graph.node</a></span> array</span> <span class="arrow">&#45;&gt;</span></span>
Expand Down
Loading

0 comments on commit a839af0

Please sign in to comment.