simon/sidekick
1
0
Fork 0
mirror of https://github.com/c-cube/sidekick.git synced 2025-12-09 04:35:35 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

deploy: 4ac2eb25a6

Browse source
This commit is contained in:
c-cube 2021-12-08 02:30:55 +00:00
parent 49009aa346
commit 2b48901535
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
dev/sidekick/Sidekick_tef/index.html
View file

@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Sidekick_tef (sidekick.Sidekick_tef)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.0.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../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">sidekick</a> &#x00BB; Sidekick_tef</nav><header class="odoc-preamble"><h1>Module <code><span>Sidekick_tef</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#tracing-event-format">Tracing Event Format</a></li></ul></nav><div class="odoc-content"><h2 id="tracing-event-format"><a href="#tracing-event-format" class="anchor"></a>Tracing Event Format</h2><p>A nice profiling format based on json, useful for visualizing what goes on. It provides a backend for <a href="../Sidekick_util/Profile/index.html"><code>Sidekick_util.Profile</code></a> so that profiling probes will emit TEF events.</p><p>Profiling is enabled if <a href="#val-setup"><code>setup</code></a> is called, and if the environment variable &quot;TEF&quot; is set to &quot;1&quot; or &quot;true&quot;. The trace is emitted in the file &quot;trace.json.gz&quot; in the directory where the solver is launched; you can open it in chrome/chromium at &quot;chrome://tracing&quot;.</p><p><a href="https://github.com/wolfpld/tracy">Tracy</a> can import (uncompressed) trace files with a nice native trace explorer.</p><p>See <a href="https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/">the documentation of TEF</a></p><div class="odoc-spec"><div class="spec value" id="val-setup" class="anchored"><a href="#val-setup" class="anchor"></a><code><span><span class="keyword">val</span> setup : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Install the TEF logger as a profiling backend.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-teardown" class="anchored"><a href="#val-teardown" class="anchor"></a><code><span><span class="keyword">val</span> teardown : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Sidekick_tef (sidekick.Sidekick_tef)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.0.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../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">sidekick</a> &#x00BB; Sidekick_tef</nav><header class="odoc-preamble"><h1>Module <code><span>Sidekick_tef</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#tracing-event-format">Tracing Event Format</a></li></ul></nav><div class="odoc-content"><h2 id="tracing-event-format"><a href="#tracing-event-format" class="anchor"></a>Tracing Event Format</h2><p>A nice profiling format based on json, useful for visualizing what goes on. It provides a backend for <a href="../Sidekick_util/Profile/index.html"><code>Sidekick_util.Profile</code></a> so that profiling probes will emit TEF events.</p><p>Profiling is enabled if <a href="#val-setup"><code>setup</code></a> is called, and if the environment variable &quot;TEF&quot; is set to &quot;1&quot; or &quot;true&quot;. The trace is emitted in the file &quot;trace.json.gz&quot; in the directory where the solver is launched; you can open it in chrome/chromium at &quot;chrome://tracing&quot;.</p><p><a href="https://github.com/wolfpld/tracy">Tracy</a> can import (uncompressed) trace files with a nice native trace explorer.</p><p>See <a href="https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/">the documentation of TEF</a></p><div class="odoc-spec"><div class="spec value" id="val-setup" class="anchored"><a href="#val-setup" class="anchor"></a><code><span><span class="keyword">val</span> setup : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Install the TEF logger as a profiling backend.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-teardown" class="anchored"><a href="#val-teardown" class="anchor"></a><code><span><span class="keyword">val</span> teardown : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-with_setup" class="anchored"><a href="#val-with_setup" class="anchor"></a><code><span><span class="keyword">val</span> with_setup : <span><span>(<span>unit <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span></span></code></div></div></div></body></html>