<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>pages/README.md - fork/rust_serialization_benchmark @ master</title>
<meta name="description" content="pages/README.md in fork/rust_serialization_benchmark at master.">
<meta property="og:title" content="pages/README.md - fork/rust_serialization_benchmark @ master">
<meta property="og:description" content="pages/README.md in fork/rust_serialization_benchmark at master.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="master" data-tip="c26f391a2f136fefa0410bc3b2dd471569587035">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/rust_serialization_benchmark</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/rust_serialization_benchmark</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Cai Bear</span><span class="commit-message" data-commit="b0ae6135cae25aac3afff89f353462c5e933cb82">[no-bench] Add interactive website via Github Pages (#46)</span><span class="snapshot-sha sha" data-commit="b0ae6135cae25aac3afff89f353462c5e933cb82">b0ae613</span><time datetime="2023-07-14T15:21:38-07:00" title="2023-07-14 15:21:38 -0700">2023-07-14</time></p>
<header class="topbar"><details class="switcher"><summary>master</summary><div class="menu"><strong>branches</strong><a href="/fork/rust_serialization_benchmark/ref/bebop/">bebop</a><a href="/fork/rust_serialization_benchmark/ref/gh-pages/">gh-pages</a><a class="current" href="/fork/rust_serialization_benchmark/ref/master/">master</a><a class="all" href="/fork/rust_serialization_benchmark/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/rust_serialization_benchmark/">rust_serialization_benchmark</a> / <a href="/fork/rust_serialization_benchmark/ref/master/tree/pages/">pages</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>1.9 KiB</span><span>31 lines</span></span><span class="actions"><a class="raw" href="/fork/rust_serialization_benchmark/raw/b678d2e74a84b40018373989b93c5f3db9d6d807/pages/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>Rust Serialization Benchmark Interactive Site</h1>
<h2>Inputs</h2>
<ul>
<li>Bandwidth: in terabytes per month. 1 TB/Mo is 0.38 megabytes per second or 3.04 megabits per second</li>
<li>CPU: fraction of CPU benchmarks were run on available for use (if &gt; 1 assumes 0 overhead for parallelization)</li>
<li>Dataset: (see ../README.md) changes messages/s to e.g. logs/s
<ul>
<li>log: logs (benchmark size divided by 10000, equal to individual logs in benchmark)</li>
<li>mesh: meshes (benchmark size)</li>
<li>minecraft_savedata: saves (benchmark size divided by 500, equal to individual player saves in benchmark)</li>
<li>mk48: updates (benchmark size divided by 1000, equal to individual updates in benchmark)</li>
</ul>
</li>
<li>Mode:
<ul>
<li>serialize: Bandwidth usage is size of compressed data, CPU usage is serialization + compression</li>
<li>deserialize: Bandwidth usage is size of compressed data, CPU usage is decompression + deserialization (crates without deserialize are excluded)</li>
<li>round trip: Bandwidth/CPU usage is sum of Mode serialize and Mode deserialize (crates without deserialize are excluded)</li>
</ul>
</li>
<li>zlib: allow using zlib as Compression</li>
<li>zstd: allow using zstd as Compression</li>
</ul>
<h2>Outputs</h2>
<ul>
<li>Crate: which crate is being used for serialization/deserialization</li>
<li>Compression: which compression algorithm is deemed the best (most messages/s) for that crate</li>
<li>messages/s: how many messages could theoretically be sent per second based on available Bandwidth/CPU consumed by compressed data/serialization + compression</li>
<li>Relative: normalized messages/s</li>
<li>Bottleneck: whether Bandwidth or CPU runs out first (limiting messages/s)</li>
</ul>
<h2>Assumptions</h2>
<ul>
<li>zlib/zstd have a constant speed irrelevant of Dataset (hopefully we can fix this)</li>
<li>1 message of size 1000 takes the same Bandwidth/CPU as 1000 messages of size 1</li>
<li>The amount of messages that need to be sent per second is constant (if each day you had all of your messages in a 1-hour interval, your real CPU requirement would be 24x)</li>
</ul>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>Rust Serialization Benchmark Interactive Site</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"><a-p>##</a-p> <a-tt>Inputs</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"><a-p>* </a-p>Bandwidth: in terabytes per month. 1 TB/Mo is 0.38 megabytes per second or 3.04 megabits per second</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"><a-p>* </a-p>CPU: fraction of CPU benchmarks were run on available for use (if &gt; 1 assumes 0 overhead for parallelization)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>* </a-p>Dataset: (see ../README.md) changes messages/s to e.g. logs/s</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>  * </a-p>log: logs (benchmark size divided by 10000, equal to individual logs in benchmark)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>  * </a-p>mesh: meshes (benchmark size)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>  * </a-p>minecraft_savedata: saves (benchmark size divided by 500, equal to individual player saves in benchmark)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>  * </a-p>mk48: updates (benchmark size divided by 1000, equal to individual updates in benchmark)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>* </a-p>Mode:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>  * </a-p>serialize: Bandwidth usage is size of compressed data, CPU usage is serialization + compression</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>  * </a-p>deserialize: Bandwidth usage is size of compressed data, CPU usage is decompression + deserialization (crates without deserialize are excluded)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>  * </a-p>round trip: Bandwidth/CPU usage is sum of Mode serialize and Mode deserialize (crates without deserialize are excluded)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>* </a-p>zlib: allow using zlib as Compression</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>* </a-p>zstd: allow using zstd as Compression</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>## </a-p><a-tt>Outputs</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>* Crate: which crate is being used for serialization/deserialization</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>* Compression: which compression algorithm is deemed the best (most messages/s) for that crate</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>* messages/s: how many messages could theoretically be sent per second based on available Bandwidth/CPU consumed by compressed data/serialization + compression</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>* Relative: normalized messages/s</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>* Bottleneck: whether Bandwidth or CPU runs out first (limiting messages/s)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>## </a-p><a-tt>Assumptions</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>* zlib/zstd have a constant speed irrelevant of Dataset (hopefully we can fix this)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>* 1 message of size 1000 takes the same Bandwidth/CPU as 1000 messages of size 1</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>* </a-p>The amount of messages that need to be sent per second is constant (if each day you had all of your messages in a 1-hour interval, your real CPU requirement would be 24x)</span></span></pre></div></div>
</main>
</body>
</html>
