From 95c65e5449c5a33d743548b968e0b513b9d48129 Mon Sep 17 00:00:00 2001 From: drebs Date: Tue, 11 Jul 2017 13:47:29 -0300 Subject: [doc] unify benchmark pages --- docs/benchmarks.rst | 24 ++++++++++++++++++++++-- docs/tests.rst | 20 +------------------- 2 files changed, 23 insertions(+), 21 deletions(-) diff --git a/docs/benchmarks.rst b/docs/benchmarks.rst index 0439f7d4..69724aa0 100644 --- a/docs/benchmarks.rst +++ b/docs/benchmarks.rst @@ -1,11 +1,31 @@ +.. _benchmarks: + Benchmarks ========== -Soledad has a set of benchmark tests to assess the time and resources taken by -various tasks. +We currently use `pytest-benchmark `_ +to write tests to assess the time and resources taken by various tasks. Results of benchmarking can be seen in https://benchmarks.leap.se/. +Test repetition +--------------- + +`pytest-benchmark` runs tests multiple times so it can provide meaningful +statistics for the time taken for a tipical run of a test function. The number +of times that the test is run can be manually or automatically configured. When +automatically configured, the number of runs is decided by taking into account +multiple `pytest-benchmark` configuration parameters. See the `the +corresponding documenation +`_ for more +details on how automatic calibration works. + +The actual number of times a test is run depends on many parameters: the time +taken for a sample run and the configuration of the minimum number of rounds +and maximum time allowed for a benchmark. For a snapshot of the number of +rounds for each test function see `the soledad benchmarks wiki page +`_. + Sync size statistics -------------------- diff --git a/docs/tests.rst b/docs/tests.rst index d6391dd2..3c80a898 100644 --- a/docs/tests.rst +++ b/docs/tests.rst @@ -31,22 +31,4 @@ Benchmark tests --------------- A set of benchmark tests is provided to measure the time and resources taken to -perform some actions. - -`pytest-benchmark` runs tests multiple times so it can provide meaningful -statistics for the time taken for a tipical run of a test function. The number -of times that the test is run can be manually or automatically configured. When -automatically configured, the number of runs is decided by taking into account -multiple `pytest-benchmark` configuration parameters. See the `the -corresponding documenation -`_ for more -details on how automatic calibration works. - -The actual number of times a test is run depends on many parameters: the time -taken for a sample run and the configuration of the minimum number of rounds -and maximum time allowed for a benchmark. For a snapshot of the number of -rounds for each test function see `the soledad benchmarks wiki page -`_. - -Some graphs and analysis resulting from these tests can be seen on `the -benchmarks page `_. +perform some actions. See the :ref:`documentation for benchmarks `. -- cgit v1.2.3