Skip to content

Commit

Permalink
Update multicore-bench doc for main
Browse files Browse the repository at this point in the history
  • Loading branch information
@polytypic
polytypic committed Oct 11, 2024
1 parent b7efbf9 commit cf8b798
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 2 additions & 0 deletions doc/multicore-bench/Multicore_bench/Countdown/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Countdown (multicore-bench.Multicore_bench.Countdown)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><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; Countdown</nav><header class="odoc-preamble"><h1>Module <code><span>Multicore_bench.Countdown</span></code></h1><p>Scalable low-level countdown.</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 countdown counter.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span><span class="label">n_domains</span>:int <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>create ~n_domains ()</code> returns a new countdown counter with initial value of <code>0</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-non_atomic_set"><a href="#val-non_atomic_set" class="anchor"></a><code><span><span class="keyword">val</span> non_atomic_set : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>non_atomic_set countdown count</code> sets the <code>count</code> of the <code>countdown</code>.</p><p>⚠️ This operation is not atomic. However, it is safe to call <code>non_atomic_set</code> with the same <code>countdown</code> and <code>count</code> in parallel, because the <code>countdown</code> will be initialized deterministically.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get"><a href="#val-get" class="anchor"></a><code><span><span class="keyword">val</span> get : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p><code>get countdown</code> returns the count of the <code>countdown</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-alloc"><a href="#val-alloc" class="anchor"></a><code><span><span class="keyword">val</span> alloc : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">domain_index</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span class="label">batch</span>:int <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p><code>alloc countdown ~domain_index ~batch</code> tries to reduce the count of the <code>countdown</code> by at most <code>batch</code> (which must be positive) and returns the number by which the count was reduced or <code>0</code> in case the count was already <code>0</code>.</p></div></div></div></body></html>
2 changes: 1 addition & 1 deletion doc/multicore-bench/Multicore_bench/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>Multicore_bench (multicore-bench.Multicore_bench)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><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; Multicore_bench</nav><header class="odoc-preamble"><h1>Module <code><span>Multicore_bench</span></code></h1><p>Multicore bench is a framework for writing multicore benchmark executables to run on <a href="https://github.com/ocurrent/current-bench">current-bench</a>.</p><p>To use the framework one typically opens it</p><pre class="language-ocaml"><code>open Multicore_bench</code></pre><p>which brings a number of submodules into scope.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Trend"><a href="#module-Trend" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Trend/index.html">Trend</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Dealing with trends.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Metric"><a href="#module-Metric" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Metric/index.html">Metric</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Dealing with benchmark metrics.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Unit_of_rate"><a href="#module-Unit_of_rate" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Unit_of_rate/index.html">Unit_of_rate</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Dealing with units of rate.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Unit_of_time"><a href="#module-Unit_of_time" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Unit_of_time/index.html">Unit_of_time</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Dealing with units of time.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Times"><a href="#module-Times" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Times/index.html">Times</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Recording timings of benchmarks running on multiple domains in parallel and producing metrics from the recorded timings.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Suite"><a href="#module-Suite" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Suite/index.html">Suite</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Dealing with benchmark suites.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Cmd"><a href="#module-Cmd" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Cmd/index.html">Cmd</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Command line interface for a benchmark executable.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Util"><a href="#module-Util" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Util/index.html">Util</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Utilities for creating benchmarks.</p></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Multicore_bench (multicore-bench.Multicore_bench)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><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; Multicore_bench</nav><header class="odoc-preamble"><h1>Module <code><span>Multicore_bench</span></code></h1><p>Multicore bench is a framework for writing multicore benchmark executables to run on <a href="https://github.com/ocurrent/current-bench">current-bench</a>.</p><p>To use the framework one typically opens it</p><pre class="language-ocaml"><code>open Multicore_bench</code></pre><p>which brings a number of submodules into scope.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Trend"><a href="#module-Trend" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Trend/index.html">Trend</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Dealing with trends.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Metric"><a href="#module-Metric" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Metric/index.html">Metric</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Dealing with benchmark metrics.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Unit_of_rate"><a href="#module-Unit_of_rate" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Unit_of_rate/index.html">Unit_of_rate</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Dealing with units of rate.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Unit_of_time"><a href="#module-Unit_of_time" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Unit_of_time/index.html">Unit_of_time</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Dealing with units of time.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Times"><a href="#module-Times" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Times/index.html">Times</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Recording timings of benchmarks running on multiple domains in parallel and producing metrics from the recorded timings.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Suite"><a href="#module-Suite" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Suite/index.html">Suite</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Dealing with benchmark suites.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Cmd"><a href="#module-Cmd" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Cmd/index.html">Cmd</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Command line interface for a benchmark executable.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Countdown"><a href="#module-Countdown" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Countdown/index.html">Countdown</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Scalable low-level countdown.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Util"><a href="#module-Util" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Util/index.html">Util</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Utilities for creating benchmarks.</p></div></div></div></body></html>

0 comments on commit cf8b798

Please sign in to comment.