This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/arrow-datafusion.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 160fe131b0 Publish built docs triggered by
45b8b0b2afa92656c1d35728d13645db5e97f70b
160fe131b0 is described below
commit 160fe131b07b753c64c12dfcfe52701f30d666ce
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Thu Mar 28 17:15:53 2024 +0000
Publish built docs triggered by 45b8b0b2afa92656c1d35728d13645db5e97f70b
---
_sources/contributor-guide/index.md.txt | 19 +++++++++++++++++++
contributor-guide/index.html | 20 ++++++++++++++++++++
searchindex.js | 2 +-
3 files changed, 40 insertions(+), 1 deletion(-)
diff --git a/_sources/contributor-guide/index.md.txt
b/_sources/contributor-guide/index.md.txt
index d7990415e4..d3f62cb911 100644
--- a/_sources/contributor-guide/index.md.txt
+++ b/_sources/contributor-guide/index.md.txt
@@ -237,6 +237,25 @@ If the environment variable `PARQUET_FILE` is set, the
benchmark will run querie
The benchmark will automatically remove any generated parquet file on exit,
however, if interrupted (e.g. by CTRL+C) it will not. This can be useful for
analysing the particular file after the fact, or preserving it to use with
`PARQUET_FILE` in subsequent runs.
+### Comparing Baselines
+
+By default, Criterion.rs will compare the measurements against the previous
run (if any). Sometimes it's useful to keep a set of measurements around for
several runs. For example, you might want to make multiple changes to the code
while comparing against the master branch. For this situation, Criterion.rs
supports custom baselines.
+
+```
+ git checkout main
+ cargo bench --bench sql_planner -- --save-baseline main
+ git checkout YOUR_BRANCH
+ cargo bench --bench sql_planner -- --baseline main
+```
+
+Note: For MacOS it may be required to run `cargo bench` with `sudo`
+
+```
+sudo cargo bench ...
+```
+
+More information on
[Baselines](https://bheisler.github.io/criterion.rs/book/user_guide/command_line_options.html#baselines)
+
### Upstream Benchmark Suites
Instructions and tooling for running upstream benchmark suites against
DataFusion can be found in
[benchmarks](https://github.com/apache/arrow-datafusion/tree/main/benchmarks).
diff --git a/contributor-guide/index.html b/contributor-guide/index.html
index f085863d40..f7d277c137 100644
--- a/contributor-guide/index.html
+++ b/contributor-guide/index.html
@@ -455,6 +455,11 @@
Parquet SQL Benchmarks
</a>
</li>
+ <li class="toc-h3 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#comparing-baselines">
+ Comparing Baselines
+ </a>
+ </li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#upstream-benchmark-suites">
Upstream Benchmark Suites
@@ -750,6 +755,21 @@ and tries to follow the Rust standard <a class="reference
external" href="https:
<p>If the environment variable <code class="docutils literal
notranslate"><span class="pre">PARQUET_FILE</span></code> is set, the benchmark
will run queries against this file instead of a randomly generated one. This
can be useful for performing multiple runs, potentially with different code,
against the same source data, or for testing against a custom dataset.</p>
<p>The benchmark will automatically remove any generated parquet file on exit,
however, if interrupted (e.g. by CTRL+C) it will not. This can be useful for
analysing the particular file after the fact, or preserving it to use with
<code class="docutils literal notranslate"><span
class="pre">PARQUET_FILE</span></code> in subsequent runs.</p>
</section>
+<section id="comparing-baselines">
+<h3>Comparing Baselines<a class="headerlink" href="#comparing-baselines"
title="Link to this heading">¶</a></h3>
+<p>By default, Criterion.rs will compare the measurements against the previous
run (if any). Sometimes it’s useful to keep a set of measurements around for
several runs. For example, you might want to make multiple changes to the code
while comparing against the master branch. For this situation, Criterion.rs
supports custom baselines.</p>
+<div class="highlight-default notranslate"><div
class="highlight"><pre><span></span> <span class="n">git</span> <span
class="n">checkout</span> <span class="n">main</span>
+ <span class="n">cargo</span> <span class="n">bench</span> <span
class="o">--</span><span class="n">bench</span> <span
class="n">sql_planner</span> <span class="o">--</span> <span
class="o">--</span><span class="n">save</span><span class="o">-</span><span
class="n">baseline</span> <span class="n">main</span>
+ <span class="n">git</span> <span class="n">checkout</span> <span
class="n">YOUR_BRANCH</span>
+ <span class="n">cargo</span> <span class="n">bench</span> <span
class="o">--</span><span class="n">bench</span> <span
class="n">sql_planner</span> <span class="o">--</span> <span
class="o">--</span><span class="n">baseline</span> <span class="n">main</span>
+</pre></div>
+</div>
+<p>Note: For MacOS it may be required to run <code class="docutils literal
notranslate"><span class="pre">cargo</span> <span
class="pre">bench</span></code> with <code class="docutils literal
notranslate"><span class="pre">sudo</span></code></p>
+<div class="highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="n">sudo</span> <span
class="n">cargo</span> <span class="n">bench</span> <span class="o">...</span>
+</pre></div>
+</div>
+<p>More information on <a class="reference external"
href="https://bheisler.github.io/criterion.rs/book/user_guide/command_line_options.html#baselines";>Baselines</a></p>
+</section>
<section id="upstream-benchmark-suites">
<h3>Upstream Benchmark Suites<a class="headerlink"
href="#upstream-benchmark-suites" title="Link to this heading">¶</a></h3>
<p>Instructions and tooling for running upstream benchmark suites against
DataFusion can be found in <a class="reference external"
href="https://github.com/apache/arrow-datafusion/tree/main/benchmarks";>benchmarks</a>.</p>
diff --git a/searchindex.js b/searchindex.js
index 3723ec2615..66f48f0fff 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["contributor-guide/architecture",
"contributor-guide/communication", "contributor-guide/index",
"contributor-guide/quarterly_roadmap", "contributor-guide/roadmap",
"contributor-guide/specification/index",
"contributor-guide/specification/invariants",
"contributor-guide/specification/output-field-name-semantic", "index",
"library-user-guide/adding-udfs", "library-user-guide/building-logical-plans",
"library-user-guide/catalogs", "library-user-guide/custom-tab [...]
\ No newline at end of file
+Search.setIndex({"docnames": ["contributor-guide/architecture",
"contributor-guide/communication", "contributor-guide/index",
"contributor-guide/quarterly_roadmap", "contributor-guide/roadmap",
"contributor-guide/specification/index",
"contributor-guide/specification/invariants",
"contributor-guide/specification/output-field-name-semantic", "index",
"library-user-guide/adding-udfs", "library-user-guide/building-logical-plans",
"library-user-guide/catalogs", "library-user-guide/custom-tab [...]
\ No newline at end of file
