Skip to content

Commit

Permalink
Update multicore-bench doc for 0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@polytypic
polytypic committed Feb 15, 2024
1 parent acae003 commit da9023f
Show file tree
Hide file tree
Showing 12 changed files with 1,993 additions and 10 deletions.
4 changes: 3 additions & 1 deletion 0.1.0/multicore-bench/Multicore_bench/Cmd/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Cmd (multicore-bench.Multicore_bench.Cmd)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><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">multicore-bench</a> &#x00BB; <a href="../index.html">Multicore_bench</a> &#x00BB; Cmd</nav><header class="odoc-preamble"><h1>Module <code><span>Multicore_bench.Cmd</span></code></h1><p>Command line interface for a benchmark executable.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-run"><a href="#val-run" class="anchor"></a><code><span><span class="keyword">val</span> run :
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Cmd (multicore-bench.Multicore_bench.Cmd)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script><script>let base_url = '../../../';
let search_urls = ['../../db.js','../../../sherlodoc.js'];
</script><script src="../../../odoc.support/odoc_search.js" defer="defer"></script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">multicore-bench</a> &#x00BB; <a href="../index.html">Multicore_bench</a> &#x00BB; Cmd</nav><div class="odoc-search"><div class="search-inner"><input class="search-bar" placeholder="🔎 Search..."/><div class="search-snake"></div><div class="search-result"></div></div></div><header class="odoc-preamble"><h1>Module <code><span>Multicore_bench.Cmd</span></code></h1><p>Command line interface for a benchmark executable.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-run"><a href="#val-run" class="anchor"></a><code><span><span class="keyword">val</span> run :
<span><span class="label">benchmarks</span>:<span><span>(string * <a href="../Suite/index.html#type-t">Suite.t</a>)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?budgetf</span>:float <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?filters</span>:<span>string list</span> <span class="arrow">&#45;&gt;</span></span>
Expand Down
4 changes: 3 additions & 1 deletion 0.1.0/multicore-bench/Multicore_bench/Metric/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Metric (multicore-bench.Multicore_bench.Metric)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><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">multicore-bench</a> &#x00BB; <a href="../index.html">Multicore_bench</a> &#x00BB; Metric</nav><header class="odoc-preamble"><h1>Module <code><span>Multicore_bench.Metric</span></code></h1><p>Dealing with benchmark metrics.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div><div class="spec-doc"><p>Represents a metric.</p></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Metric (multicore-bench.Multicore_bench.Metric)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script><script>let base_url = '../../../';
let search_urls = ['../../db.js','../../../sherlodoc.js'];
</script><script src="../../../odoc.support/odoc_search.js" defer="defer"></script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">multicore-bench</a> &#x00BB; <a href="../index.html">Multicore_bench</a> &#x00BB; Metric</nav><div class="odoc-search"><div class="search-inner"><input class="search-bar" placeholder="🔎 Search..."/><div class="search-snake"></div><div class="search-result"></div></div></div><header class="odoc-preamble"><h1>Module <code><span>Multicore_bench.Metric</span></code></h1><p>Dealing with benchmark metrics.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div><div class="spec-doc"><p>Represents a metric.</p></div></div></div></body></html>
4 changes: 3 additions & 1 deletion 0.1.0/multicore-bench/Multicore_bench/Suite/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Suite (multicore-bench.Multicore_bench.Suite)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><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">multicore-bench</a> &#x00BB; <a href="../index.html">Multicore_bench</a> &#x00BB; Suite</nav><header class="odoc-preamble"><h1>Module <code><span>Multicore_bench.Suite</span></code></h1><p>Dealing with benchmark suites.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = <span><span class="label">budgetf</span>:float <span class="arrow">&#45;&gt;</span></span> <span><a href="../Metric/index.html#type-t">Metric.t</a> list</span></span></code></div><div class="spec-doc"><p>Represents a benchmark suite, i.e. a function that produces a list of metric outputs for <a href="https://github.com/ocurrent/current-bench">current-bench</a>.</p></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Suite (multicore-bench.Multicore_bench.Suite)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script><script>let base_url = '../../../';
let search_urls = ['../../db.js','../../../sherlodoc.js'];
</script><script src="../../../odoc.support/odoc_search.js" defer="defer"></script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">multicore-bench</a> &#x00BB; <a href="../index.html">Multicore_bench</a> &#x00BB; Suite</nav><div class="odoc-search"><div class="search-inner"><input class="search-bar" placeholder="🔎 Search..."/><div class="search-snake"></div><div class="search-result"></div></div></div><header class="odoc-preamble"><h1>Module <code><span>Multicore_bench.Suite</span></code></h1><p>Dealing with benchmark suites.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = <span><span class="label">budgetf</span>:float <span class="arrow">&#45;&gt;</span></span> <span><a href="../Metric/index.html#type-t">Metric.t</a> list</span></span></code></div><div class="spec-doc"><p>Represents a benchmark suite, i.e. a function that produces a list of metric outputs for <a href="https://github.com/ocurrent/current-bench">current-bench</a>.</p></div></div></div></body></html>
4 changes: 3 additions & 1 deletion 0.1.0/multicore-bench/Multicore_bench/Times/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Times (multicore-bench.Multicore_bench.Times)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><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">multicore-bench</a> &#x00BB; <a href="../index.html">Multicore_bench</a> &#x00BB; Times</nav><header class="odoc-preamble"><h1>Module <code><span>Multicore_bench.Times</span></code></h1><p>Recording timings of benchmarks running on multiple domains in parallel and producing metrics from the recorded timings.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div><div class="spec-doc"><p>Represents a record of elapsed times of multiple runs of a benchmark running on multiple domains.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-record"><a href="#val-record" class="anchor"></a><code><span><span class="keyword">val</span> record :
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Times (multicore-bench.Multicore_bench.Times)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script><script>let base_url = '../../../';
let search_urls = ['../../db.js','../../../sherlodoc.js'];
</script><script src="../../../odoc.support/odoc_search.js" defer="defer"></script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">multicore-bench</a> &#x00BB; <a href="../index.html">Multicore_bench</a> &#x00BB; Times</nav><div class="odoc-search"><div class="search-inner"><input class="search-bar" placeholder="🔎 Search..."/><div class="search-snake"></div><div class="search-result"></div></div></div><header class="odoc-preamble"><h1>Module <code><span>Multicore_bench.Times</span></code></h1><p>Recording timings of benchmarks running on multiple domains in parallel and producing metrics from the recorded timings.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div><div class="spec-doc"><p>Represents a record of elapsed times of multiple runs of a benchmark running on multiple domains.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-record"><a href="#val-record" class="anchor"></a><code><span><span class="keyword">val</span> record :
<span><span class="label">budgetf</span>:float <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">n_domains</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?ensure_multi_domain</span>:bool <span class="arrow">&#45;&gt;</span></span>
Expand Down
4 changes: 3 additions & 1 deletion 0.1.0/multicore-bench/Multicore_bench/Unit_of_rate/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Unit_of_rate (multicore-bench.Multicore_bench.Unit_of_rate)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><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">multicore-bench</a> &#x00BB; <a href="../index.html">Multicore_bench</a> &#x00BB; Unit_of_rate</nav><header class="odoc-preamble"><h1>Module <code><span>Multicore_bench.Unit_of_rate</span></code></h1><p>Dealing with units of rate.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = </span><span>[ </span></code><ol><li id="type-t._1" class="def variant constructor anchored"><a href="#type-t._1" class="anchor"></a><code><span>| </span><span>`_1</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>1/s</p><span class="comment-delim">*)</span></div></li><li id="type-t.k" class="def variant constructor anchored"><a href="#type-t.k" class="anchor"></a><code><span>| </span><span>`k</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>10<sup>3</sup>/s or k/s</p><span class="comment-delim">*)</span></div></li><li id="type-t.M" class="def variant constructor anchored"><a href="#type-t.M" class="anchor"></a><code><span>| </span><span>`M</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>10<sup>6</sup>/s or M/s</p><span class="comment-delim">*)</span></div></li><li id="type-t.G" class="def variant constructor anchored"><a href="#type-t.G" class="anchor"></a><code><span>| </span><span>`G</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>10<sup>9</sup>/s or G/s</p><span class="comment-delim">*)</span></div></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>Represents a unit of rate, i.e. how many per second.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_divisor"><a href="#val-to_divisor" class="anchor"></a><code><span><span class="keyword">val</span> to_divisor : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> float</span></code></div><div class="spec-doc"><p><code>to_divisor t</code> converts the unit of rate <code>t</code> to a divisor.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_mnemonic"><a href="#val-to_mnemonic" class="anchor"></a><code><span><span class="keyword">val</span> to_mnemonic : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div><div class="spec-doc"><p><code>to_mnemonic t</code> returns a human readable mnemonic for the unit of rate <code>t</code>.</p></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Unit_of_rate (multicore-bench.Multicore_bench.Unit_of_rate)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script><script>let base_url = '../../../';
let search_urls = ['../../db.js','../../../sherlodoc.js'];
</script><script src="../../../odoc.support/odoc_search.js" defer="defer"></script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">multicore-bench</a> &#x00BB; <a href="../index.html">Multicore_bench</a> &#x00BB; Unit_of_rate</nav><div class="odoc-search"><div class="search-inner"><input class="search-bar" placeholder="🔎 Search..."/><div class="search-snake"></div><div class="search-result"></div></div></div><header class="odoc-preamble"><h1>Module <code><span>Multicore_bench.Unit_of_rate</span></code></h1><p>Dealing with units of rate.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = </span><span>[ </span></code><ol><li id="type-t._1" class="def variant constructor anchored"><a href="#type-t._1" class="anchor"></a><code><span>| </span><span>`_1</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>1/s</p><span class="comment-delim">*)</span></div></li><li id="type-t.k" class="def variant constructor anchored"><a href="#type-t.k" class="anchor"></a><code><span>| </span><span>`k</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>10<sup>3</sup>/s or k/s</p><span class="comment-delim">*)</span></div></li><li id="type-t.M" class="def variant constructor anchored"><a href="#type-t.M" class="anchor"></a><code><span>| </span><span>`M</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>10<sup>6</sup>/s or M/s</p><span class="comment-delim">*)</span></div></li><li id="type-t.G" class="def variant constructor anchored"><a href="#type-t.G" class="anchor"></a><code><span>| </span><span>`G</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>10<sup>9</sup>/s or G/s</p><span class="comment-delim">*)</span></div></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>Represents a unit of rate, i.e. how many per second.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_divisor"><a href="#val-to_divisor" class="anchor"></a><code><span><span class="keyword">val</span> to_divisor : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> float</span></code></div><div class="spec-doc"><p><code>to_divisor t</code> converts the unit of rate <code>t</code> to a divisor.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_mnemonic"><a href="#val-to_mnemonic" class="anchor"></a><code><span><span class="keyword">val</span> to_mnemonic : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div><div class="spec-doc"><p><code>to_mnemonic t</code> returns a human readable mnemonic for the unit of rate <code>t</code>.</p></div></div></div></body></html>
Loading

0 comments on commit da9023f

Please sign in to comment.