diff --git a/.vscode/settings.json b/.vscode/settings.json index 3391649d..cdaf5cd5 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -8,6 +8,7 @@ ], "python.testing.pytestEnabled": true, "python.testing.unittestEnabled": false, + "python.testing.cwd": "${workspaceFolder}", "explorer.autoRevealExclude": { ".mypy_cache": true, ".venv": true, @@ -51,7 +52,6 @@ "python.createEnvironment.contentButton": "show", "python.envFile": "${workspaceFolder}/.env", "python.terminal.launchArgs": [], - "python.testing.cwd": "${workspaceFolder}", "python.testing.autoTestDiscoverOnSaveEnabled": true, "pylint.cwd": "${workspaceFolder}/src", "codeQL.createQuery.qlPackLocation": "{$workspaceFolder}", diff --git a/CHANGELOG.md b/CHANGELOG.md index 9238a528..30b6a30b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,12 @@ SimpleBench A framework for building and running benchmarks. +* 0.5.0-alpha-0 2025-11-30 + * Extended CSVReporter and RichTableReporter to allow customization + of output columns using options. + * Added checked support for explict parameters in benchmark functions. + * Completed documentation for parameterized benchmarks. + * 0.4.1-alpha.0 2025-11-29 - Seventh alpha release * **Documentation Update** * Migration of README to .rst format diff --git a/README.rst b/README.rst index a18e59a3..41da17c8 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ SimpleBench =========== -**SimpleBench** is a Python framework for benchmarking and performance testing of code. +**SimpleBench** is a modern Python framework for benchmarking and performance testing of code. As such it has the following goals: @@ -48,7 +48,8 @@ Documentation * `Installation `_ * `Using SimpleBench `_ * `Tutorials `_ - * `Basic Usage Tutorial `_ + * `Basic Benchmark `_ + * `Parameterized Benchmark `_ * `Command-Line Options `_ * `Reports `_ * `Rich Table Report `_ diff --git a/docs/_downloads/88e7aae14d90ceb1db4850c2e54e5bc2/minimal_parameterized_benchmark.py b/docs/_downloads/88e7aae14d90ceb1db4850c2e54e5bc2/minimal_parameterized_benchmark.py new file mode 100644 index 00000000..97a0df63 --- /dev/null +++ b/docs/_downloads/88e7aae14d90ceb1db4850c2e54e5bc2/minimal_parameterized_benchmark.py @@ -0,0 +1,14 @@ +"""A basic parameterized benchmark.""" +import simplebench + + +@simplebench.benchmark(kwargs_variations={'size': [1, 5, 10, 50, 100, 500, 1000]}, + variation_cols={'size': 'Input Size'}, + use_field_for_n='size') +def addition_benchmark(size: int) -> None: + """A simple addition benchmark of Python's built-in sum function.""" + sum(range(size)) + + +if __name__ == "__main__": + simplebench.main() diff --git a/docs/_downloads/f8498575ecb8c45b1316b8a0fefda355/multidimensional_parameterized_benchmark.py b/docs/_downloads/f8498575ecb8c45b1316b8a0fefda355/multidimensional_parameterized_benchmark.py new file mode 100644 index 00000000..add434fc --- /dev/null +++ b/docs/_downloads/f8498575ecb8c45b1316b8a0fefda355/multidimensional_parameterized_benchmark.py @@ -0,0 +1,27 @@ +"""A multidimensional parameterized benchmark.""" +import simplebench + + +@simplebench.benchmark( + kwargs_variations={ + 'size': [10, 100, 1000], + 'mode': ['fast', 'slow'] + }, + variation_cols={ + 'size': 'Input Size', + 'mode': 'Mode' + }, + use_field_for_n='size') +def my_benchmark(size: int, mode: str) -> None: + """A benchmark for summing a range of numbers that varies by size and mode.""" + match mode: + case 'fast': + sum(range(size)) + case 'slow': + total = 0 + for i in range(size): + total += i + + +if __name__ == "__main__": + simplebench.main() diff --git a/docs/_modules/index.html b/docs/_modules/index.html index e2bd3d5c..1ba79bf8 100644 --- a/docs/_modules/index.html +++ b/docs/_modules/index.html @@ -5,13 +5,13 @@ - Overview: module code - simplebench 0.4.0-alpha.0 documentation + Overview: module code - simplebench 0.4.1-alpha.0 documentation - + @@ -163,7 +163,7 @@
-
simplebench 0.4.0-alpha.0 documentation
 +
simplebench 0.4.1-alpha.0 documentation
@@ -184,7 +184,7 @@
- simplebench 0.4.0-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation
-
+
diff --git a/docs/_modules/simplebench/case.html b/docs/_modules/simplebench/case.html index c4c45e61..496e5a0e 100644 --- a/docs/_modules/simplebench/case.html +++ b/docs/_modules/simplebench/case.html @@ -5,12 +5,13 @@ - simplebench.case - simplebench 0.4.0-alpha.0 documentation + simplebench.case - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
-
simplebench 0.4.0-alpha.0 documentation
 +
simplebench 0.4.1-alpha.0 documentation
@@ -183,7 +184,7 @@
- simplebench 0.4.0-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,9 +198,13 @@
  • Using SimpleBench
    • -
  • Tutorials
    • +
  • Tutorials +
  • Command-Line Options
    • -
  • Reports
      +
    • Reports
      • Rich Table Report
      • CSV Report
      • JSON Report
        • @@ -248,7 +253,7 @@

        Source code for simplebench.case

         import itertools
 from copy import copy
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, Callable, Iterable, Optional
+from typing import TYPE_CHECKING, Any, Callable, Iterable, Optional, get_type_hints
 
 import simplebench.defaults as defaults
 
@@ -337,102 +342,6 @@ 
        Source code for simplebench.case
         [docs]
 class Case:
     '''
-    :param benchmark_id: An optional unique identifier for the benchmark case.
-
-        If None, a transient ID is assigned. This is meant to provide a stable identifier for the
-        benchmark case across multiple runs for tracking purposes. If not provided,
-        an attempt will be made to generate a stable ID based on the the action function
-        name, signature, and group.
-
-        If that is not possible, a transient ID based on the instance's id() will be used.
-        If a transient ID is used, it will differ between runs and cannot be used to
-        correlate results across multiple runs.
-
-        Benchmark ids must be unique within a benchmarking session and stable across runs
-        or they cannot be used for tracking benchmark results over time.
-
-    :param git_info: An optional GitInfo instance representing the state of the Git repository.
-
-        If not provided, the GitInfo will be automatically retrieved from the current
-        context of the caller if the code is part of a Git repository.
-
-    :param action: The function to perform the benchmark. This function must
-        accept a `bench` instance of type SimpleRunner and arbitrary keyword arguments ('**kwargs').
-        See the :class:`~simplebench.protocols.ActionRunner` protocol for the exact function
-        signature required.
-
-        It must return a `Results` object.
-
-    :param group: The benchmark reporting group to which the benchmark case belongs.
-
-    :param title: The title of the benchmark case.
-
-        If None, the name of the action function will be used. Cannot be a blank
-        string (a string that is empty or consists only of whitespace).
-
-    :param description: A brief description of the benchmark case.
-
-        If None, the docstring of the action function will be used, or '(no description)' if no docstring
-        is available. Cannot be blank.
-    :param iterations: The minimum number of iterations to run for the benchmark.
-    :param warmup_iterations: The number of warmup iterations to run before the benchmark.
-    :param rounds: The number of rounds to run for the benchmark.
-
-        Rounds are multiple runs of calls to the action within an iteration to mitigate timer
-        quantization, loop overhead, and other measurement effects for very fast actions. Setup and teardown
-        functions are called only once per iteration (all rounds in the same iteration share the same
-        setup/teardown context).
-    :param min_time: The minimum time for the benchmark in seconds.
-    :param max_time: The maximum time for the benchmark in seconds.
-    :param timeout: How long to wait before timing out a benchmark run (in seconds).
-
-        If None, it waits the full duration of ``max_time`` plus the default timeout
-        grace period in seconds ({DEFAULT_TIMEOUT_GRACE_PERIOD} seconds). It must be a
-        positive float or int that is greater than ``max_time`` if provided.
-        This is a safety mechanism to prevent runaway benchmarks.
-
-        If the timeout is reached during a run, a :class:`~simplebench.exceptions.SimpleBenchTimeoutError``
-        will be raised.
-    :param variation_cols: kwargs to be used for cols to denote kwarg variations.
-
-        Each key is a keyword argument name, and the value is the column label to use for that
-        argument. Only keywords that are also in `kwargs_variations` can be used here. These fields will be
-        added to the output of reporters that support them as columns of data with the specified labels.
-        If None, an empty dict is used.
-    :param kwargs_variations: A mapping of keyword argument key names to
-        a list of possible values for that argument. Default is {}. When tests are run, the benchmark
-        will be executed for each combination of the specified keyword argument variations. The action
-        function will be called with a `bench` parameter that is an instance of the runner and the
-        keyword arguments for the current variation.
-        If None, an empty dict is used.
-    :param runner: A custom runner class for the benchmark.
-        Any custom runner classes must be a subclass of SimpleRunner and must have a method
-        named `run` that accepts the same parameters as SimpleRunner.run and returns a Results object.
-        The action function will be called with a `bench` parameter that is an instance of the
-        custom runner.
-        It may also accept additional parameters to the run method as needed. If additional
-        parameters are needed for the custom runner, they will need to be passed to the run
-        method as keyword arguments.
-        No support is provided for passing additional parameters to a custom runner from the @benchmark
-        decorator.
-    :param callback:
-        A callback function for additional processing of the report. The function should accept
-        four arguments: the Case instance, the Section, the Format, and the generated report data.
-        The callback function will be called with the following arguments:
-            - case (Case): The `Case` instance processed for the report.
-            - section (Section): The `Section` of the report.
-            - output_format (Format): The `Format` of the report.
-            - output (Any): The generated report data. Note that the actual type of this data will
-                depend on the Format specified for the report and the type generated by the
-                reporter for that Format
-        Omit if no callback is needed by a reporter.
-    :param options: A list of additional options for the benchmark case.
-        Each option is an instance of ReporterOption or a subclass of ReporterOption.
-        Reporter options can be used to customize the output of the benchmark reports for
-        specific reporters. Reporters are responsible for extracting applicable ReporterOptions
-        from the list of options themselves.
-        If None, an empty list is used.
-
     A benchmark case defines the specific benchmark to be run, including the
     action to be performed, the parameters for the benchmark, and any variations
     of those parameters as well as the reporting group and title for the benchmark.
@@ -499,13 +408,13 @@ 
        Source code for simplebench.case
                     Case, SimpleRunner, Results, main)
 
 
-        def my_benchmark_action(bench: SimpleRunner,
+        def my_benchmark_action(_bench: SimpleRunner,
                                 **kwargs) -> Results:
             # Perform benchmark action here
             def benchmark_operation():
                 sum(range(1000))  # Example operation to benchmark
 
-            return bench.run(benchmark_operation)
+            return _bench.run(benchmark_operation)
 
 
         if __name__ == '__main__':
@@ -514,7 +423,6 @@ 
        Source code for simplebench.case
                     ]
             main(cases_list)
 
-
     '''
     __slots__ = ('_group', '_title', '_description', '_action',
                  '_iterations', '_warmup_iterations', '_min_time', '_max_time',
@@ -541,9 +449,7 @@ 
        Source code for simplebench.case
                          runner: Optional[type[SimpleRunner]] = None,
                  callback: Optional[ReporterCallback] = None,
                  options: Optional[Iterable[ReporterOptions]] = None) -> None:
-        """Constructor for Case. This defines a benchmark case.
-
-        The only REQUIRED parameter is `action`.
+        """The only REQUIRED parameter is `action`.
 
         :param benchmark_id: An optional unique identifier for the benchmark case.
 
@@ -567,9 +473,8 @@ 
        Source code for simplebench.case
                     protocol for the exact signature required. It must return a `Results` object.
         :param group: The benchmark reporting group to which the benchmark case belongs.
 
-        Benchmarks with the same group can be selected for execution without running
-        other benchmarks. If not specified, the default group 'default' is used.
-
+            Benchmarks with the same group can be selected for execution without running
+            other benchmarks. If not specified, the default group 'default' is used.
         :param title: The title of the benchmark case.
 
             If None, the name of the action function will be used. Cannot be blank.
@@ -625,12 +530,14 @@ 
        Source code for simplebench.case
         
             The function should must four arguments: the Case instance, the Section,
             the Format, and the generated report data.
-                - case (Case): The `Case` instance processed for the report.
-                - section (Section): The `Section` of the report.
-                - output_format (Format): The `Format` of the report.
-                - output (Any): The generated report data. Note that the actual type of this data will
-                    depend on the Format specified for the report and the type generated by the
-                    reporter for that Format
+
+            - case (Case): The `Case` instance processed for the report.
+            - section (Section): The `Section` of the report.
+            - output_format (Format): The `Format` of the report.
+            - output (Any): The generated report data. Note that the actual type of this data will
+                depend on the Format specified for the report and the type generated by the
+                reporter for that Format
+
             Omit if no callback is needed by a reporter.
         :param options: A list of additional options for the benchmark case.
 
@@ -639,12 +546,17 @@ 
        Source code for simplebench.case
                     specific reporters. Reporters are responsible for extracting applicable ReporterOptions
             from the list of options themselves.
             If None, an empty list is used.
+        :raises SimpleBenchTypeError: If any parameter is of incorrect type.
+        :raises SimpleBenchValueError: If any parameter has an invalid value.
         """
         self._group = validate_non_blank_string(
                         group, "group",
                         _CaseErrorTag.INVALID_GROUP_TYPE,
                         _CaseErrorTag.INVALID_GROUP_VALUE)
-        self._action = Case.validate_action_signature(action)
+        # Processed first so can be used for cross-validation of action signature
+        self._kwargs_variations = Case.validate_kwargs_variations(kwargs_variations)
+        self._action = Case.validate_action_signature(action=action,
+                                                      kwargs_variations=self._kwargs_variations)
         title = action.__name__ if title is None else title  # type: ignore[attr-defined]
         self._title = validate_non_blank_string(
                         title, "title",
@@ -698,7 +610,6 @@ 
        Source code for simplebench.case
                         _CaseErrorTag.INVALID_BENCHMARK_ID_TYPE,
                 _CaseErrorTag.INVALID_BENCHMARK_ID_VALUE,
                 strip=True, allow_blank=False, allow_empty=False)
-        self._kwargs_variations = Case.validate_kwargs_variations(kwargs_variations)
         self._variation_cols = Case.validate_variation_cols(variation_cols, self._kwargs_variations)
         self._runner = Case.validate_runner(runner)
         self._callback = validate_reporter_callback(callback, allow_none=True)
@@ -730,43 +641,96 @@ 
        Source code for simplebench.case
         
        
 [docs]
     @staticmethod
-    def validate_action_signature(action: ActionRunner) -> ActionRunner:
+    def validate_action_signature(action: ActionRunner,
+                                  kwargs_variations: dict[str, Any]) -> ActionRunner:
         """Validate that action has correct signature.
 
-        An action function must accept the following two parameters:
-            - bench: SimpleRunner
+        An action function must accept one of the two following formats for its parameters:
+
+        **Two Parameters**
+            - _bench: SimpleRunner
             - **kwargs: Arbitrary keyword arguments
 
+        **Explicit Parameters**
+            - _bench: SimpleRunner
+            - any number of explicit parameters
+
         This is equivalent to the `ActionRunner` protocol.
 
         :param action: The action function to validate.
-        :type action: ActionRunner
+        :param kwargs_variations: The kwargs variations for the case.
         :return: The validated action function.
-        :rtype: ActionRunner
-        :raises SimpleBenchTypeError: If the action is not callable or has an invalid signature.
+        :raises SimpleBenchTypeError: If the action is not callable or has an invalid signature or
+            if the kwargs_variations is not a dictionary with valid keys or if the action signature
+            does not match the kwargs_variations keys.
         """
         if not callable(action):
             raise SimpleBenchTypeError(
                 f'Invalid action: {action}. Must be a callable.',
                 tag=_CaseErrorTag.INVALID_ACTION_NOT_CALLABLE
                 )
+
+        # Resolve type hints to handle string annotations (from __future__ import annotations)
+        try:
+            type_hints = get_type_hints(action)
+        except Exception:  # pylint: disable=broad-exception-caught
+            # Fallback for callables where get_type_hints might fail (e.g. partials without globals)
+            type_hints = {}
+
         action_signature = inspect.signature(action)
-        if 'bench' not in action_signature.parameters:
+        kwargs_variations = Case.validate_kwargs_variations(kwargs_variations)
+
+        bench_param = action_signature.parameters.get('_bench')
+        if bench_param is None:
             raise SimpleBenchTypeError(
-                f'Invalid action: {action}. Must accept a "bench" parameter.',
+                f'Invalid action: {action}. Must accept a "_bench" parameter.',
                 tag=_CaseErrorTag.INVALID_ACTION_MISSING_BENCH_PARAMETER
                 )
-        kwargs_param = action_signature.parameters.get('kwargs')
-        if kwargs_param is None or kwargs_param.kind not in (inspect.Parameter.VAR_KEYWORD,):
+        if bench_param.annotation is inspect.Parameter.empty:
             raise SimpleBenchTypeError(
-                f'Invalid action: {action}. Must accept "**kwargs" parameter.',
-                tag=_CaseErrorTag.INVALID_ACTION_MISSING_KWARGS_PARAMETER
+                f'Invalid action: {action}. "_bench" parameter must be annotated with SimpleRunner.',
+                tag=_CaseErrorTag.INVALID_ACTION_BENCH_PARAMETER_NOT_ANNOTATED
                 )
-        if len(action_signature.parameters) != 2:
-            raise SimpleBenchValueError(
-                f'Invalid action: {action}. Must accept exactly 2 parameters: bench and **kwargs.',
-                tag=_CaseErrorTag.INVALID_ACTION_PARAMETER_COUNT
-            )
+
+        # Use the resolved type hint if available, otherwise use the annotation from signature
+        actual_annotation = type_hints.get('_bench', bench_param.annotation)
+
+        if actual_annotation != SimpleRunner:
+            raise SimpleBenchTypeError(
+                f'Invalid action: {action}. "_bench" parameter must be of type SimpleRunner.',
+                tag=_CaseErrorTag.INVALID_ACTION_BENCH_PARAMETER_WRONG_TYPE
+                )
+
+        # No arguments other than _bench
+        if len(action_signature.parameters) == 1:
+            return action
+
+        # Two arguments: _bench and **kwargs
+        if len(action_signature.parameters) == 2:
+            # Check for **kwargs parameter
+            kwargs_param = action_signature.parameters.get('kwargs')
+            if kwargs_param is not None and kwargs_param.kind == inspect.Parameter.VAR_KEYWORD:
+                return action
+
+        # 2 or more arguments, _bench and explicit keyword-only parameters
+        for param_name in action_signature.parameters:
+            if param_name == '_bench':
+                continue
+            if param_name not in kwargs_variations:
+                raise SimpleBenchTypeError(
+                    (f'Invalid action: {action}. Parameter "{param_name}" '
+                     'not found in kwargs_variations.'),
+                    tag=_CaseErrorTag.INVALID_ACTION_PARAMETER_NOT_IN_KWARGS_VARIATIONS
+                    )
+        for param_name in kwargs_variations:
+            if param_name not in action_signature.parameters:
+                raise SimpleBenchTypeError(
+                    (f'Invalid action: {action}. kwargs_variations key "{param_name}" '
+                     'not found in action parameters.'),
+                    tag=_CaseErrorTag.INVALID_ACTION_KWARGS_VARIATIONS_KEY_NOT_IN_PARAMETERS
+                    )
+
+        # All checks passed
         return action
        
 
 
@@ -904,7 +868,6 @@ 
        Source code for simplebench.case
                 """Validate the options list.
 
         :param value: The options iterable to validate or None.
-        :type value: Iterable[ReporterOption] | None
         :return: A shallow copy of the validated options as a list or an empty list if not provided.
         :rtype: list[ReporterOptions]
         :raises SimpleBenchTypeError: If options is not a list or if any entry is not a ReporterOption.
@@ -1265,7 +1228,6 @@ 
        Source code for simplebench.case
                 set `full_data` to True.
 
         :param full_data: Whether to include full results data. Defaults to False.
-        :type full_data: bool
         :return: A JSON serializable dict representation of the benchmark case and results.
         :rtype: dict[str, Any]
         """
@@ -1315,11 +1277,12 @@ 
        Source code for simplebench.case
               
     
   
        
-
        
+
        
     
     
     
     
     
+    
     
 
\ No newline at end of file
diff --git a/docs/_modules/simplebench/cli.html b/docs/_modules/simplebench/cli.html
index f57edf77..3cfeeb33 100644
--- a/docs/_modules/simplebench/cli.html
+++ b/docs/_modules/simplebench/cli.html
@@ -5,12 +5,13 @@
     
 
     
-        simplebench.cli - simplebench 0.4.0-alpha.0 documentation
+        simplebench.cli - simplebench 0.4.1-alpha.0 documentation
       
     
     
+    
     
-    
+    
     
     
 
@@ -162,7 +163,7 @@
       
     
        
     
        
-      
        simplebench 0.4.0-alpha.0 documentation
        
+      
        simplebench 0.4.1-alpha.0 documentation
        
     
        
     
        
       
        
@@ -183,7 +184,7 @@
       
       
        
   
-  simplebench 0.4.0-alpha.0 documentation
+  simplebench 0.4.1-alpha.0 documentation
   
 
   
@@ -197,9 +198,13 @@
 
      • Using SimpleBench
          
 
        
 
        • 
-
      • Tutorials
        • 
+
      • Tutorials
+
        • 
 
      • Command-Line Options
        • 
-
      • Reports
        • 
+
        
     
     
     
     
     
+    
     
 
\ No newline at end of file
diff --git a/docs/_modules/simplebench/decorators.html b/docs/_modules/simplebench/decorators.html
index a7366b76..520d6d2b 100644
--- a/docs/_modules/simplebench/decorators.html
+++ b/docs/_modules/simplebench/decorators.html
@@ -5,12 +5,13 @@
     
 
     
-        simplebench.decorators - simplebench 0.4.0-alpha.0 documentation
+        simplebench.decorators - simplebench 0.4.1-alpha.0 documentation
       
     
     
+    
     
-    
+    
     
     
 
@@ -162,7 +163,7 @@
       
     
        
     
        
-      
        simplebench 0.4.0-alpha.0 documentation
        
+      
        simplebench 0.4.1-alpha.0 documentation
        
     
        
     
        
       
        
@@ -183,7 +184,7 @@
       
       
        
   
-  simplebench 0.4.0-alpha.0 documentation
+  simplebench 0.4.1-alpha.0 documentation
   
 
   
@@ -197,9 +198,13 @@
 
      • Using SimpleBench
          
 
        
 
        • 
-
      • Tutorials
        • 
+
      • Tutorials
+
        • 
 
      • Command-Line Options
        • 
-
      • Reports
        • 
         
@@ -295,11 +373,12 @@ 
        Source code for simplebench.reporters.csv.reporter.options.options
        
   
        
-
        
+
        
     
     
     
     
     
+    
     
 
\ No newline at end of file
diff --git a/docs/_modules/simplebench/reporters/csv/reporter/reporter.html b/docs/_modules/simplebench/reporters/csv/reporter/reporter.html
index 74c21861..34e60802 100644
--- a/docs/_modules/simplebench/reporters/csv/reporter/reporter.html
+++ b/docs/_modules/simplebench/reporters/csv/reporter/reporter.html
@@ -5,12 +5,13 @@
     
 
     
-        simplebench.reporters.csv.reporter.reporter - simplebench 0.3.1-alpha.0 documentation
+        simplebench.reporters.csv.reporter.reporter - simplebench 0.4.1-alpha.0 documentation
       
     
     
+    
     
-    
+    
     
     
 
@@ -162,7 +163,7 @@
       
     
        
     
        
-      
        simplebench 0.3.1-alpha.0 documentation
        
+      
        simplebench 0.4.1-alpha.0 documentation
        
     
        
     
        
       
        
@@ -183,7 +184,7 @@
       
       
        
   
-  simplebench 0.3.1-alpha.0 documentation
+  simplebench 0.4.1-alpha.0 documentation
   
 
   
@@ -197,8 +198,13 @@
 
      • Using SimpleBench
          
 
        
 
        • 
+
      • Tutorials
+
        • 
 
      • Command-Line Options
        • 
-
      • Reports
        • 
         
@@ -331,11 +396,12 @@ 
        Source code for simplebench.reporters.rich_table.reporter.options.options
   
        
-
        
+
        
     
     
     
     
     
+    
     
 
\ No newline at end of file
diff --git a/docs/_modules/simplebench/reporters/rich_table/reporter/reporter.html b/docs/_modules/simplebench/reporters/rich_table/reporter/reporter.html
index df0f9dfb..54a4c5c0 100644
--- a/docs/_modules/simplebench/reporters/rich_table/reporter/reporter.html
+++ b/docs/_modules/simplebench/reporters/rich_table/reporter/reporter.html
@@ -5,12 +5,13 @@
     
 
     
-        simplebench.reporters.rich_table.reporter.reporter - simplebench 0.3.1-alpha.0 documentation
+        simplebench.reporters.rich_table.reporter.reporter - simplebench 0.4.1-alpha.0 documentation
       
     
     
+    
     
-    
+    
     
     
 
@@ -162,7 +163,7 @@
        -
        simplebench 0.3.1-alpha.0 documentation
         +
        simplebench 0.4.1-alpha.0 documentation
        @@ -183,7 +184,7 @@
        - simplebench 0.3.1-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,8 +198,13 @@
      • Using SimpleBench
        • +
      • Tutorials +
      • Command-Line Options
        • -
      • Reports
          +
        • Reports
          • Rich Table Report
          • CSV Report
          • JSON Report
            • @@ -250,7 +256,6 @@

            Source code for simplebench.reporters.rich_table.reporter.reporter

            from simplebench.defaults import DEFAULT_INTERVAL_SCALE from simplebench.enums import Section from simplebench.exceptions import SimpleBenchTypeError -# simplebench.reporters imports from simplebench.reporters.reporter import Reporter, ReporterOptions from simplebench.results import Results from simplebench.si_units import si_scale_for_smallest @@ -260,7 +265,7 @@

            Source code for simplebench.reporters.rich_table.reporter.reporter

            from .config import RichTableConfig from .exceptions import _RichTableReporterErrorTag -from .options import RichTableOptions +from .options import RichTableField, RichTableOptions Options: TypeAlias = RichTableOptions @@ -338,6 +343,11 @@

            Source code for simplebench.reporters.rich_table.reporter.reporter

            It creates a :class:`~rich.table.Table` instance containing the benchmark results for the specified section. + The table includes the fields specified in the `options` argument, formatted + appropriately based on the results data. + + Depending on the `options`, variation columns can be placed at the start or end of the rows. + :param case: The :class:`~simplebench.case.Case` instance representing the benchmarked code. :param options: The options specifying the report configuration. @@ -355,6 +365,7 @@

            Source code for simplebench.reporters.rich_table.reporter.reporter

            _RichTableReporterErrorTag.RENDER_INVALID_SECTION) options = validate_type(options, Options, 'options', _RichTableReporterErrorTag.RENDER_INVALID_OPTIONS) + included_fields = options.fields base_unit: str = self.get_base_unit_for_section(section=section) results: list[Results] = case.results @@ -385,38 +396,82 @@

            Source code for simplebench.reporters.rich_table.reporter.reporter

            show_header=True, title_style='bold green1', header_style='bold magenta') - table.add_column('N', justify='center') - table.add_column('Iterations', justify='center') - table.add_column('Rounds', justify='center') - table.add_column('Elapsed Seconds', justify='center', max_width=7) - table.add_column(f'mean {mean_unit}', justify='center', vertical='bottom', overflow='fold') - table.add_column(f'median {median_unit}', justify='center', vertical='bottom', overflow='fold') - table.add_column(f'min {min_unit}', justify='center', vertical='bottom', overflow='fold') - table.add_column(f'max {max_unit}', justify='center', vertical='bottom', overflow='fold') - table.add_column(f'5th {p5_unit}', justify='center', vertical='bottom', overflow='fold') - table.add_column(f'95th {p95_unit}', justify='center', vertical='bottom', overflow='fold') - table.add_column(f'std dev {stddev_unit}', justify='center', vertical='bottom', overflow='fold') - table.add_column('rsd%', justify='center', vertical='bottom', overflow='fold') - for value in case.variation_cols.values(): - table.add_column(value, justify='center', vertical='bottom', overflow='fold') + + if not options.variation_cols_last: + for value in case.variation_cols.values(): + table.add_column(value, justify='center', vertical='bottom', overflow='fold') + + for field in included_fields: + match field: + case RichTableField.N: + table.add_column('N', justify='center') + case RichTableField.ITERATIONS: + table.add_column('Iterations', justify='center') + case RichTableField.ROUNDS: + table.add_column('Rounds', justify='center') + case RichTableField.ELAPSED_SECONDS: + table.add_column('Elapsed Seconds', justify='center', max_width=7) + case RichTableField.MEAN: + table.add_column(f'mean {mean_unit}', justify='center', vertical='bottom', overflow='fold') + case RichTableField.MEDIAN: + table.add_column(f'median {median_unit}', justify='center', vertical='bottom', overflow='fold') + case RichTableField.MIN: + table.add_column(f'min {min_unit}', justify='center', vertical='bottom', overflow='fold') + case RichTableField.MAX: + table.add_column(f'max {max_unit}', justify='center', vertical='bottom', overflow='fold') + case RichTableField.P5: + table.add_column(f'5th {p5_unit}', justify='center', vertical='bottom', overflow='fold') + case RichTableField.P95: + table.add_column(f'95th {p95_unit}', justify='center', vertical='bottom', overflow='fold') + case RichTableField.STD_DEV: + table.add_column(f'std dev {stddev_unit}', justify='center', vertical='bottom', overflow='fold') + case RichTableField.RSD_PERCENT: + table.add_column('rsd%', justify='center', vertical='bottom', overflow='fold') + + if options.variation_cols_last: + for value in case.variation_cols.values(): + table.add_column(value, justify='center', vertical='bottom', overflow='fold') + for result in results: stats_target = result.results_section(section) - row: list[str] = [ - f'{str(result.n):>6}', - f'{len(result.iterations):>6d}', - f'{result.rounds:>6d}', - f'{result.total_elapsed * DEFAULT_INTERVAL_SCALE:>4.2f}', - f'{sigfigs(stats_target.mean * mean_scale):>8.2f}', - f'{sigfigs(stats_target.median * median_scale):>8.2f}', - f'{sigfigs(stats_target.minimum * min_scale):>8.2f}', - f'{sigfigs(stats_target.maximum * max_scale):>8.2f}', - f'{sigfigs(stats_target.percentiles[5] * p5_scale):>8.2f}', - f'{sigfigs(stats_target.percentiles[95] * p95_scale):>8.2f}', - f'{sigfigs(stats_target.adjusted_standard_deviation * stddev_scale):>8.2f}', - f'{sigfigs(stats_target.adjusted_relative_standard_deviation):>5.2f}%' - ] - for value in result.variation_marks.values(): - row.append(f'{value!s}') + row: list[str] = [] + + if not options.variation_cols_last: + for value in result.variation_marks.values(): + row.append(f'{value!s}') + + # Add main fields + for field in included_fields: + match field: + case RichTableField.N: + row.append(f'{str(result.n):>6}') + case RichTableField.ITERATIONS: + row.append(f'{len(result.iterations):>6d}') + case RichTableField.ROUNDS: + row.append(f'{result.rounds:>6d}') + case RichTableField.ELAPSED_SECONDS: + row.append(f'{result.total_elapsed * DEFAULT_INTERVAL_SCALE:>4.2f}') + case RichTableField.MEAN: + row.append(f'{sigfigs(stats_target.mean * mean_scale):>8.2f}') + case RichTableField.MEDIAN: + row.append(f'{sigfigs(stats_target.median * median_scale):>8.2f}') + case RichTableField.MIN: + row.append(f'{sigfigs(stats_target.minimum * min_scale):>8.2f}') + case RichTableField.MAX: + row.append(f'{sigfigs(stats_target.maximum * max_scale):>8.2f}') + case RichTableField.P5: + row.append(f'{sigfigs(stats_target.percentiles[5] * p5_scale):>8.2f}') + case RichTableField.P95: + row.append(f'{sigfigs(stats_target.percentiles[95] * p95_scale):>8.2f}') + case RichTableField.STD_DEV: + row.append(f'{sigfigs(stats_target.adjusted_standard_deviation * stddev_scale):>8.2f}') + case RichTableField.RSD_PERCENT: + row.append(f'{sigfigs(stats_target.adjusted_relative_standard_deviation):>5.2f}%') + + if options.variation_cols_last: + for value in result.variation_marks.values(): + row.append(f'{value!s}') + table.add_row(*row) return table
            @@ -454,11 +509,12 @@

            Source code for simplebench.reporters.rich_table.reporter.reporter

            -
            +
            + \ No newline at end of file diff --git a/docs/_modules/simplebench/reporters/validators/validators.html b/docs/_modules/simplebench/reporters/validators/validators.html index a18b39e8..e143640c 100644 --- a/docs/_modules/simplebench/reporters/validators/validators.html +++ b/docs/_modules/simplebench/reporters/validators/validators.html @@ -5,12 +5,13 @@ - simplebench.reporters.validators.validators - simplebench 0.3.1-alpha.0 documentation + simplebench.reporters.validators.validators - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
            -
            simplebench 0.3.1-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -183,7 +184,7 @@
            - simplebench 0.3.1-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,8 +198,13 @@
          • Using SimpleBench
            • +
          • Tutorials +
          • Command-Line Options
            • -
          • Reports
              +
            • Reports
              • Rich Table Report
              • CSV Report
              • JSON Report
                • @@ -528,11 +534,12 @@

                Source code for simplebench.reporters.validators.validators

                +
                + \ No newline at end of file diff --git a/docs/_modules/simplebench/results.html b/docs/_modules/simplebench/results.html index 54b659a5..b732f186 100644 --- a/docs/_modules/simplebench/results.html +++ b/docs/_modules/simplebench/results.html @@ -5,12 +5,13 @@ - simplebench.results - simplebench 0.3.1-alpha.0 documentation + simplebench.results - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
            • -
            simplebench 0.3.1-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -183,7 +184,7 @@
            - simplebench 0.3.1-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,8 +198,13 @@
          • Using SimpleBench
            • +
          • Tutorials +
          • Command-Line Options
            • -
          • Reports
            • +
            + \ No newline at end of file diff --git a/docs/_modules/simplebench/runners.html b/docs/_modules/simplebench/runners.html index 380076c6..9228a586 100644 --- a/docs/_modules/simplebench/runners.html +++ b/docs/_modules/simplebench/runners.html @@ -5,12 +5,13 @@ - simplebench.runners - simplebench 0.3.1-alpha.0 documentation + simplebench.runners - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
            -
            simplebench 0.3.1-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -183,7 +184,7 @@
            - simplebench 0.3.1-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,8 +198,13 @@
          • Using SimpleBench
            • +
          • Tutorials +
          • Command-Line Options
            • -
          • Reports
            • +
            + \ No newline at end of file diff --git a/docs/_modules/simplebench/session.html b/docs/_modules/simplebench/session.html index 4dc58747..4ecee4d3 100644 --- a/docs/_modules/simplebench/session.html +++ b/docs/_modules/simplebench/session.html @@ -5,12 +5,13 @@ - simplebench.session - simplebench 0.4.0-alpha.0 documentation + simplebench.session - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
            -
            simplebench 0.4.0-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -183,7 +184,7 @@
            - simplebench 0.4.0-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,9 +198,13 @@
          • Using SimpleBench
            • -
          • Tutorials
            • +
          • Tutorials +
          • Command-Line Options
            • -
          • Reports
            • +
            + \ No newline at end of file diff --git a/docs/_modules/simplebench/si_units.html b/docs/_modules/simplebench/si_units.html index edf452e8..94fb9879 100644 --- a/docs/_modules/simplebench/si_units.html +++ b/docs/_modules/simplebench/si_units.html @@ -5,12 +5,13 @@ - simplebench.si_units - simplebench 0.3.1-alpha.0 documentation + simplebench.si_units - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
            -
            simplebench 0.3.1-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -183,7 +184,7 @@
            - simplebench 0.3.1-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,8 +198,13 @@
          • Using SimpleBench
            • +
          • Tutorials +
          • Command-Line Options
            • -
          • Reports
            • +
            + \ No newline at end of file diff --git a/docs/_modules/simplebench/stats/memory_usage.html b/docs/_modules/simplebench/stats/memory_usage.html index 4452d1fa..191cef18 100644 --- a/docs/_modules/simplebench/stats/memory_usage.html +++ b/docs/_modules/simplebench/stats/memory_usage.html @@ -5,12 +5,13 @@ - simplebench.stats.memory_usage - simplebench 0.3.1-alpha.0 documentation + simplebench.stats.memory_usage - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
            -
            simplebench 0.3.1-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -183,7 +184,7 @@
            - simplebench 0.3.1-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,8 +198,13 @@
          • Using SimpleBench
            • +
          • Tutorials +
          • Command-Line Options
            • -
          • Reports
            • +
            + \ No newline at end of file diff --git a/docs/_modules/simplebench/stats/operation_timings.html b/docs/_modules/simplebench/stats/operation_timings.html index 6da8176e..01007c35 100644 --- a/docs/_modules/simplebench/stats/operation_timings.html +++ b/docs/_modules/simplebench/stats/operation_timings.html @@ -5,12 +5,13 @@ - simplebench.stats.operation_timings - simplebench 0.3.1-alpha.0 documentation + simplebench.stats.operation_timings - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
            -
            simplebench 0.3.1-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -183,7 +184,7 @@
            - simplebench 0.3.1-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,8 +198,13 @@
          • Using SimpleBench
            • +
          • Tutorials +
          • Command-Line Options
            • -
          • Reports
              +
            • Reports
              • Rich Table Report
              • CSV Report
              • JSON Report
                • @@ -391,11 +397,12 @@

                Source code for simplebench.stats.operation_timings

                +
                + \ No newline at end of file diff --git a/docs/_modules/simplebench/stats/operations_per_interval.html b/docs/_modules/simplebench/stats/operations_per_interval.html index cd816a1a..ce710ffd 100644 --- a/docs/_modules/simplebench/stats/operations_per_interval.html +++ b/docs/_modules/simplebench/stats/operations_per_interval.html @@ -5,12 +5,13 @@ - simplebench.stats.operations_per_interval - simplebench 0.3.1-alpha.0 documentation + simplebench.stats.operations_per_interval - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
            • -
            simplebench 0.3.1-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -183,7 +184,7 @@
            - simplebench 0.3.1-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,8 +198,13 @@
          • Using SimpleBench
            • +
          • Tutorials +
          • Command-Line Options
            • -
          • Reports
              +
            • Reports
              • Rich Table Report
              • CSV Report
              • JSON Report
                • @@ -391,11 +397,12 @@

                Source code for simplebench.stats.operations_per_interval

                +
                + \ No newline at end of file diff --git a/docs/_modules/simplebench/stats/peak_memory_usage.html b/docs/_modules/simplebench/stats/peak_memory_usage.html index 77a0b54d..0223276f 100644 --- a/docs/_modules/simplebench/stats/peak_memory_usage.html +++ b/docs/_modules/simplebench/stats/peak_memory_usage.html @@ -5,12 +5,13 @@ - simplebench.stats.peak_memory_usage - simplebench 0.3.1-alpha.0 documentation + simplebench.stats.peak_memory_usage - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
            • -
            simplebench 0.3.1-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -183,7 +184,7 @@
            - simplebench 0.3.1-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,8 +198,13 @@
          • Using SimpleBench
            • +
          • Tutorials +
          • Command-Line Options
            • -
          • Reports
              +
            • Reports
              • Rich Table Report
              • CSV Report
              • JSON Report
                • @@ -392,11 +398,12 @@

                Source code for simplebench.stats.peak_memory_usage

                +
                + \ No newline at end of file diff --git a/docs/_modules/simplebench/stats/stats.html b/docs/_modules/simplebench/stats/stats.html index 23a48289..335fc4d0 100644 --- a/docs/_modules/simplebench/stats/stats.html +++ b/docs/_modules/simplebench/stats/stats.html @@ -5,12 +5,13 @@ - simplebench.stats.stats - simplebench 0.3.1-alpha.0 documentation + simplebench.stats.stats - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
            • -
            simplebench 0.3.1-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -183,7 +184,7 @@
            - simplebench 0.3.1-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,8 +198,13 @@
          • Using SimpleBench
            • +
          • Tutorials +
          • Command-Line Options
            • -
          • Reports
            • +
            + \ No newline at end of file diff --git a/docs/_modules/simplebench/tasks.html b/docs/_modules/simplebench/tasks.html index d76596fe..1fd92d32 100644 --- a/docs/_modules/simplebench/tasks.html +++ b/docs/_modules/simplebench/tasks.html @@ -5,12 +5,13 @@ - simplebench.tasks - simplebench 0.3.1-alpha.0 documentation + simplebench.tasks - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
            -
            simplebench 0.3.1-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -183,7 +184,7 @@
            - simplebench 0.3.1-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,8 +198,13 @@
          • Using SimpleBench
            • +
          • Tutorials +
          • Command-Line Options
            • -
          • Reports
            • +
            + \ No newline at end of file diff --git a/docs/_modules/simplebench/timeout/enums.html b/docs/_modules/simplebench/timeout/enums.html index e8608361..5c73d12b 100644 --- a/docs/_modules/simplebench/timeout/enums.html +++ b/docs/_modules/simplebench/timeout/enums.html @@ -5,12 +5,13 @@ - simplebench.timeout.enums - simplebench 0.3.1-alpha.0 documentation + simplebench.timeout.enums - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
            -
            simplebench 0.3.1-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -183,7 +184,7 @@
            - simplebench 0.3.1-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,8 +198,13 @@
          • Using SimpleBench
            • +
          • Tutorials +
          • Command-Line Options
            • -
          • Reports
            • +
            + \ No newline at end of file diff --git a/docs/_modules/simplebench/timeout/thread_id.html b/docs/_modules/simplebench/timeout/thread_id.html index 4a7adaee..14560381 100644 --- a/docs/_modules/simplebench/timeout/thread_id.html +++ b/docs/_modules/simplebench/timeout/thread_id.html @@ -5,12 +5,13 @@ - simplebench.timeout.thread_id - simplebench 0.3.1-alpha.0 documentation + simplebench.timeout.thread_id - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
            -
            simplebench 0.3.1-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -183,7 +184,7 @@
            - simplebench 0.3.1-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,8 +198,13 @@
          • Using SimpleBench
            • +
          • Tutorials +
          • Command-Line Options
            • -
          • Reports
            • +
            + \ No newline at end of file diff --git a/docs/_modules/simplebench/timeout/timeout.html b/docs/_modules/simplebench/timeout/timeout.html index 8c0381a9..092f92b9 100644 --- a/docs/_modules/simplebench/timeout/timeout.html +++ b/docs/_modules/simplebench/timeout/timeout.html @@ -5,12 +5,13 @@ - simplebench.timeout.timeout - simplebench 0.3.1-alpha.0 documentation + simplebench.timeout.timeout - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
            -
            simplebench 0.3.1-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -183,7 +184,7 @@
            - simplebench 0.3.1-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,8 +198,13 @@
          • Using SimpleBench
            • +
          • Tutorials +
          • Command-Line Options
            • -
          • Reports
            • +
            + \ No newline at end of file diff --git a/docs/_modules/simplebench/type_proxies/case_type_proxy.html b/docs/_modules/simplebench/type_proxies/case_type_proxy.html index d09f0ff9..2d0bc8b1 100644 --- a/docs/_modules/simplebench/type_proxies/case_type_proxy.html +++ b/docs/_modules/simplebench/type_proxies/case_type_proxy.html @@ -5,12 +5,13 @@ - simplebench.type_proxies.case_type_proxy - simplebench 0.3.1-alpha.0 documentation + simplebench.type_proxies.case_type_proxy - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
            -
            simplebench 0.3.1-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -183,7 +184,7 @@
            - simplebench 0.3.1-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,8 +198,13 @@
          • Using SimpleBench
            • +
          • Tutorials +
          • Command-Line Options
            • -
          • Reports
              +
            • Reports
              • Rich Table Report
              • CSV Report
              • JSON Report
                • @@ -341,11 +347,12 @@

                Source code for simplebench.type_proxies.case_type_proxy

                +
                + \ No newline at end of file diff --git a/docs/_modules/simplebench/type_proxies/choice_type_proxy.html b/docs/_modules/simplebench/type_proxies/choice_type_proxy.html index 1f924dac..cf9ca9f6 100644 --- a/docs/_modules/simplebench/type_proxies/choice_type_proxy.html +++ b/docs/_modules/simplebench/type_proxies/choice_type_proxy.html @@ -5,12 +5,13 @@ - simplebench.type_proxies.choice_type_proxy - simplebench 0.3.1-alpha.0 documentation + simplebench.type_proxies.choice_type_proxy - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
            • -
            simplebench 0.3.1-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -183,7 +184,7 @@
            - simplebench 0.3.1-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,8 +198,13 @@
          • Using SimpleBench
            • +
          • Tutorials +
          • Command-Line Options
            • -
          • Reports
              +
            • Reports
              • Rich Table Report
              • CSV Report
              • JSON Report
                • @@ -341,11 +347,12 @@

                Source code for simplebench.type_proxies.choice_type_proxy

                +
                + \ No newline at end of file diff --git a/docs/_modules/simplebench/type_proxies/lazy_type_proxy.html b/docs/_modules/simplebench/type_proxies/lazy_type_proxy.html index 0abe8496..9ed66f1a 100644 --- a/docs/_modules/simplebench/type_proxies/lazy_type_proxy.html +++ b/docs/_modules/simplebench/type_proxies/lazy_type_proxy.html @@ -5,12 +5,13 @@ - simplebench.type_proxies.lazy_type_proxy - simplebench 0.3.1-alpha.0 documentation + simplebench.type_proxies.lazy_type_proxy - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
            • -
            simplebench 0.3.1-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -183,7 +184,7 @@
            - simplebench 0.3.1-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,8 +198,13 @@
          • Using SimpleBench
            • +
          • Tutorials +
          • Command-Line Options
            • -
          • Reports
              +
            • Reports
              • Rich Table Report
              • CSV Report
              • JSON Report
                • @@ -383,11 +389,12 @@

                Source code for simplebench.type_proxies.lazy_type_proxy

                +
                + \ No newline at end of file diff --git a/docs/_modules/simplebench/type_proxies/reporter_type_proxy.html b/docs/_modules/simplebench/type_proxies/reporter_type_proxy.html index fd681208..afc67c33 100644 --- a/docs/_modules/simplebench/type_proxies/reporter_type_proxy.html +++ b/docs/_modules/simplebench/type_proxies/reporter_type_proxy.html @@ -5,12 +5,13 @@ - simplebench.type_proxies.reporter_type_proxy - simplebench 0.3.1-alpha.0 documentation + simplebench.type_proxies.reporter_type_proxy - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
            • -
            simplebench 0.3.1-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -183,7 +184,7 @@
            - simplebench 0.3.1-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,8 +198,13 @@
          • Using SimpleBench
            • +
          • Tutorials +
          • Command-Line Options
            • -
          • Reports
            • +
            + \ No newline at end of file diff --git a/docs/_modules/simplebench/type_proxies/session_type_proxy.html b/docs/_modules/simplebench/type_proxies/session_type_proxy.html index 5bfd9b13..477f975c 100644 --- a/docs/_modules/simplebench/type_proxies/session_type_proxy.html +++ b/docs/_modules/simplebench/type_proxies/session_type_proxy.html @@ -5,12 +5,13 @@ - simplebench.type_proxies.session_type_proxy - simplebench 0.3.1-alpha.0 documentation + simplebench.type_proxies.session_type_proxy - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
            -
            simplebench 0.3.1-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -183,7 +184,7 @@
            - simplebench 0.3.1-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,8 +198,13 @@
          • Using SimpleBench
            • +
          • Tutorials +
          • Command-Line Options
            • -
          • Reports
              +
            • Reports
              • Rich Table Report
              • CSV Report
              • JSON Report
                • @@ -334,11 +340,12 @@

                Source code for simplebench.type_proxies.session_type_proxy

                +
                + \ No newline at end of file diff --git a/docs/_modules/simplebench/utils.html b/docs/_modules/simplebench/utils.html index 36646a6f..73c9ed27 100644 --- a/docs/_modules/simplebench/utils.html +++ b/docs/_modules/simplebench/utils.html @@ -5,12 +5,13 @@ - simplebench.utils - simplebench 0.3.1-alpha.0 documentation + simplebench.utils - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
            • -
            simplebench 0.3.1-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -183,7 +184,7 @@
            - simplebench 0.3.1-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,8 +198,13 @@
          • Using SimpleBench
            • +
          • Tutorials +
          • Command-Line Options
            • -
          • Reports
            • +
            + \ No newline at end of file diff --git a/docs/_modules/simplebench/validators/misc.html b/docs/_modules/simplebench/validators/misc.html index 643a1b31..1bd2f54f 100644 --- a/docs/_modules/simplebench/validators/misc.html +++ b/docs/_modules/simplebench/validators/misc.html @@ -5,12 +5,13 @@ - simplebench.validators.misc - simplebench 0.3.1-alpha.0 documentation + simplebench.validators.misc - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
            -
            simplebench 0.3.1-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -183,7 +184,7 @@
            - simplebench 0.3.1-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,8 +198,13 @@
          • Using SimpleBench
            • +
          • Tutorials +
          • Command-Line Options
            • -
          • Reports
            • +
            + \ No newline at end of file diff --git a/docs/_modules/simplebench/validators/validate_iterable_of_type.html b/docs/_modules/simplebench/validators/validate_iterable_of_type.html index 22deb564..78febb26 100644 --- a/docs/_modules/simplebench/validators/validate_iterable_of_type.html +++ b/docs/_modules/simplebench/validators/validate_iterable_of_type.html @@ -5,12 +5,13 @@ - simplebench.validators.validate_iterable_of_type - simplebench 0.3.1-alpha.0 documentation + simplebench.validators.validate_iterable_of_type - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
            -
            simplebench 0.3.1-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -183,7 +184,7 @@
            - simplebench 0.3.1-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,8 +198,13 @@
          • Using SimpleBench
            • +
          • Tutorials +
          • Command-Line Options
            • -
          • Reports
            • +
            + \ No newline at end of file diff --git a/docs/_modules/simplebench/validators/validate_sequence_of_type.html b/docs/_modules/simplebench/validators/validate_sequence_of_type.html index e15eb5be..a1ac8d1a 100644 --- a/docs/_modules/simplebench/validators/validate_sequence_of_type.html +++ b/docs/_modules/simplebench/validators/validate_sequence_of_type.html @@ -5,12 +5,13 @@ - simplebench.validators.validate_sequence_of_type - simplebench 0.3.1-alpha.0 documentation + simplebench.validators.validate_sequence_of_type - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
            -
            simplebench 0.3.1-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -183,7 +184,7 @@
            - simplebench 0.3.1-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,8 +198,13 @@
          • Using SimpleBench
            • +
          • Tutorials +
          • Command-Line Options
            • -
          • Reports
            • +
            + \ No newline at end of file diff --git a/docs/_modules/simplebench/vcs.html b/docs/_modules/simplebench/vcs.html index d95a3494..50cf88c0 100644 --- a/docs/_modules/simplebench/vcs.html +++ b/docs/_modules/simplebench/vcs.html @@ -5,12 +5,13 @@ - simplebench.vcs - simplebench 0.3.1-alpha.0 documentation + simplebench.vcs - simplebench 0.4.1-alpha.0 documentation + - + @@ -162,7 +163,7 @@
            -
            simplebench 0.3.1-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -183,7 +184,7 @@
            - simplebench 0.3.1-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -197,8 +198,13 @@
          • Using SimpleBench
            • +
          • Tutorials +
          • Command-Line Options
            • -
          • Reports
            • +
            + \ No newline at end of file diff --git a/docs/_sources/basic.rst.txt b/docs/_sources/basic.rst.txt deleted file mode 100644 index b124cb57..00000000 --- a/docs/_sources/basic.rst.txt +++ /dev/null @@ -1,34 +0,0 @@ -==================== -Basic Usage Tutorial -==================== - -This tutorial demonstrates how to create a simple benchmark using SimpleBench, run it, and generate a report. - - -The minimal code required to create and run a benchmark using SimpleBench is creating -a script that defines a function to be benchmarked with `@simplebench.benchmark` -and that calls `simplebench.main()` and then running it. - -When you run the code below, SimpleBench automatically runs the benchmark function -`addition_benchmark`, collecting performance and memory statistics, and generating -a report. By specifying :doc:`command_line_options` you can generate output in -multiple formats, including rich text tables (like the one below), graphs, CSV -files, and JSON reports and select which statistics to report. - -It runs using defaults setting for number of iterations, warmup runs, etc. You can -customize these settings via parameters set on the `@simplebench.benchmark` decorator. - -.. literalinclude:: basic/basic_benchmark.py - :language: python - :caption: A basic benchmark example - :name: basic-benchmark-example - :linenos: - -Save this code to a file, for example `basic_benchmark.py`, and then run it from -your terminal: - -.. code-block:: shell - :caption: Generate a rich table report by running the benchmark - :name: run-basic-benchmark - - python basic_benchmark.py --rich-table.ops --progress diff --git a/docs/_sources/tutorials.rst.txt b/docs/_sources/tutorials.rst.txt index 4da999cb..41c4aded 100644 --- a/docs/_sources/tutorials.rst.txt +++ b/docs/_sources/tutorials.rst.txt @@ -18,10 +18,10 @@ Tutorials to advanced reporting techniques, you'll find a variety of topics covered here. - .. toctree:: :name: tutorials :maxdepth: 1 :caption: List of Tutorials - tutorials/basic \ No newline at end of file + tutorials/basic + tutorials/parameterized \ No newline at end of file diff --git a/docs/_sources/tutorials/basic.rst.txt b/docs/_sources/tutorials/basic.rst.txt index 1c18d403..e79b9348 100644 --- a/docs/_sources/tutorials/basic.rst.txt +++ b/docs/_sources/tutorials/basic.rst.txt @@ -1,9 +1,11 @@ -==================== -Basic Usage Tutorial -==================== +=============== +Basic Benchmark +=============== -This tutorial demonstrates how to create a simple benchmark using SimpleBench, run it, and generate a report. +.. _simplebench-tutorials-basic: +This tutorial demonstrates how to create a simple benchmark using SimpleBench, +run it, and generate a report. The minimal code required to create and run a benchmark using SimpleBench is creating a script that defines a function to be benchmarked with `@simplebench.benchmark` @@ -35,7 +37,7 @@ your terminal: This will produce output similar to the following: -.. literalinclude:: basic/expected_output.txt +.. literalinclude:: basic/basic_output.txt :caption: Expected Output from Running the Basic Benchmark :name: expected-basic-benchmark-output :language: text @@ -53,11 +55,17 @@ of the documentation. .. TO REGENERATE THE GOLDEN MASTER FILE FOR THIS TEST: - From the 'documentation/' directory, run the following command: - python _helpers/doctest_utils.py tutorials/basic/expected_output.txt tutorials/basic/basic_benchmark.py --rich-table.ops + From the basic/ directory, run the following command: - The doctests will verify that the output of the benchmark script matches this - expected output: if the output changes unexpectedly, the doctest will fail. + python basic_benchmark.py --rich-table.ops > basic_output.txt + + The --progress option is omitted here because it produces dynamic output + that changes as the benchmark runs and does not appear in the expected output file + when piped to a file instead of the terminal anyway. + + The doctests will verify that the output of the benchmark script matches the + format of the expected output: if the output format changes unexpectedly, + the doctest will fail. Doctests are run from the 'documentation/' directory, so paths in the test configuration are relative to that directory: 'make doctest' handles this @@ -69,7 +77,7 @@ of the documentation. # Paths are relative to the 'documentation/' directory. script_to_run = "tutorials/basic/basic_benchmark.py" - expected_output_file = "tutorials/basic/expected_output.txt" + expected_output_file = "tutorials/basic/basic_output.txt" script_args = ["--rich-table.ops"] # -------------------------- diff --git a/docs/_sources/tutorials/basic/index.rst.txt b/docs/_sources/tutorials/basic/index.rst.txt deleted file mode 100644 index 3f990aec..00000000 --- a/docs/_sources/tutorials/basic/index.rst.txt +++ /dev/null @@ -1,36 +0,0 @@ -==================== -Basic Usage Tutorial -==================== - -This tutorial demonstrates how to create a simple benchmark using SimpleBench, run it, and generate a report. - - -The minimal code required to create and run a benchmark using SimpleBench is creating -a script that defines a function to be benchmarked with `@simplebench.benchmark` -and that calls `simplebench.main()` and then running it. - -When you run the code below, SimpleBench automatically runs the benchmark function -`addition_benchmark`, collecting performance and memory statistics, and generating -a report. By specifying :doc:`command_line_options` you can generate output in -multiple formats, including rich text tables (like the one below), graphs, CSV -files, and JSON reports and select which statistics to report. - -It runs using defaults setting for number of iterations, warmup runs, etc. You can -customize these settings via parameters set on the `@simplebench.benchmark` decorator. - -.. code-block:: python - :caption: A basic benchmark example - :name: basic-benchmark-example - :linenos: - - .. include:: basic_benchmark.py - :literal: - -Save this code to a file, for example `basic_benchmark.py`, and then run it from -your terminal: - -.. code-block:: shell - :caption: Generate a rich table report by running the benchmark - :name: run-basic-benchmark - - python basic_benchmark.py --rich-table.ops --progress diff --git a/docs/_sources/tutorials/parameterized.rst.txt b/docs/_sources/tutorials/parameterized.rst.txt new file mode 100644 index 00000000..3d3840e8 --- /dev/null +++ b/docs/_sources/tutorials/parameterized.rst.txt @@ -0,0 +1,221 @@ +======================= +Parameterized Benchmark +======================= + +.. _simplebench-tutorials-parameterized: + +This tutorial demonstrates how to create a parameterized benchmark using SimpleBench, run it, and generate a report. + +Parameterized benchmarks allow you to run the same benchmark function multiple times with different input parameters. + +The key components of a parameterized benchmark are: + +- **Benchmark Function**: A function decorated with `@simplebench.benchmark` that contains the code to be benchmarked. + The function must accept parameters that will be varied during the benchmark runs. The parameters are defined + as keyword arguments and passed to the function during each execution. + +- **Parameters**: Defined as arguments for the decorator, which specifies different values or sets of values to be used as inputs to the benchmark function. + +``kwarg_variations`` + A dictionary where the keys are parameter names to be passed to the benchmarked + function and values are lists of possible values for those parameters. + + The benchmark will be executed for every combination of the provided parameter values. + + **Example** + + .. code-block:: python + + kwargs_variations={ + 'arg1': [1, 2], + 'arg2': ['a', 'b'] + } + + will result in the following combinations being tested: + + .. code-block:: python + + {'arg1': 1, 'arg2': 'a'} + {'arg1': 1, 'arg2': 'b'} + {'arg1': 2, 'arg2': 'a'} + {'arg1': 2, 'arg2': 'b'} + +``variation_cols`` + A dictionary where keys are parameter names and values are display names for reporting. Fields not + included here will usually not display in a report. Fields specified here must be a subset of the + keys in ``kwarg_variations``. + + **Example** + + .. code-block:: python + + variation_cols={ + 'arg1': 'Argument 1', + 'arg2': 'Argument 2' + } + + This will result in the report displaying columns/fields labeled 'Argument 1' and 'Argument 2' + corresponding to the values of 'arg1' and 'arg2' used in each benchmark run. + +``use_field_for_n`` + A string specifying a parameter to use as the 'N' field in reports, which is often used + to indicate input size for complexity analysis. This parameter should be one of the keys in + ``kwarg_variations``. It is optional; if not specified, the 'N' field will default to the value '1.0'. + + This is useful when you want to analyze how the performance of the benchmarked function + scales with different input sizes or configurations. It is not required that the field be + defined in ``variation_cols`` to be used as the 'N' field. + +Minimal Example +--------------- + +The minimal code required to create and run a parameterized benchmark using SimpleBench is creating +a script that defines a function to be benchmarked with `@simplebench.benchmark`, +specifying parameters using the `@simplebench.benchmark` decorator, and that calls `simplebench.main()` + +.. literalinclude:: parameterized/minimal_parameterized_benchmark.py + :language: python + :caption: A minimal parameterized benchmark example + :name: minimal-parameterized-benchmark-example + :linenos: + +Save this code to a file, for example :download:`minimal_parameterized_benchmark.py `, and then run it from +your terminal: + +.. code-block:: shell + :caption: Generate a rich table report for operations-per-second by running a parameterized benchmark + :name: run-minimal-parameterized-benchmark + + python minimal_parameterized_benchmark.py --rich-table.ops --progress + +This will produce output similar to the following: + +.. literalinclude:: parameterized/minimal_parameterized_output.txt + :caption: Expected Output from Running the Parameterized Benchmark + :name: expected-parameterized-benchmark-output + :language: text + +A detailed explanation of the output format and displayed statistics shown in this +example report can be found in the :doc:`/reports/rich_table_report` section +of the documentation. + +.. note:: The command shown above includes the ``--progress`` option to + display a progress bar while the benchmark is running. This option is not + required to run the benchmark, and can be omitted if you do not wish to see + the progress bar. It is not included in the expected output file since it + produces dynamic output that changes as the benchmark runs and is removed + from the terminal once the benchmark completes. + +.. + TO REGENERATE THE GOLDEN MASTER FILE FOR THIS TEST: + + From the 'parameterized/' directory, run the following command: + + python minimal_parameterized_benchmark.py --rich-table.ops > minimal_parameterized_output.txt + + The --progress option is omitted here because it produces dynamic output + that changes as the benchmark runs and does not appear in the expected output file + when piped to a file instead of the terminal anyway. + + The doctests will verify that the output of the benchmark script matches the + format of the expected output: if the output format changes unexpectedly, + the doctest will fail. + + Doctests are run from the 'documentation/' directory, so paths in the test + configuration are relative to that directory: 'make doctest' handles this + automatically. + +.. testcode:: + :hide: + + # --- Test Configuration --- + # Paths are relative to the 'documentation/' directory. + + script_to_run = "tutorials/parameterized/minimal_parameterized_benchmark.py" + expected_output_file = "tutorials/parameterized/minimal_parameterized_output.txt" + script_args = ["--rich-table.ops"] + + # -------------------------- + + actual_output = run_script_and_get_raw_output( + script_path=script_to_run, + args=script_args + ) + assert_benchmark_output(actual_output, expected_output_file) + +Multi-dimensional Parameters +---------------------------- + +You can define multiple parameters for a benchmark function by defining multiple +parameters for the kwarg_variations. + + +For example, to benchmark a function with two parameters, `size` and `mode`, you can define +the benchmark as follows: + +.. literalinclude:: parameterized/multidimensional_parameterized_benchmark.py + :language: python + :caption: A multidimensional parameterized benchmark example + :name: multidimensional-parameterized-benchmark-example + :linenos: + +Save this code to a file, for example +:download:`multidimensional_parameterized_benchmark.py `, +and then run it from your terminal: + +.. code-block:: shell + :caption: Generate a rich table report for operations-per-second by running a multidimensional parameterized benchmark + :name: run-multidimensional-parameterized-benchmark + + python multidimensional_parameterized_benchmark.py --rich-table.ops --progress + +This will run the benchmark for all combinations of `size` and `mode`, resulting in +six different benchmark runs (3 sizes x 2 modes). The report will include columns for both +'Input Size' and 'Mode', allowing you to analyze the performance across these different dimensions. + +And you will see output similar to the following: + +.. literalinclude:: parameterized/multidimensional_parameterized_output.txt + :caption: Expected Output from Running the Multidimensional Parameterized Benchmark + :name: expected-multidimensional-parameterized-benchmark-output + :language: text + +You can customize the parameter values and names as needed for your specific benchmarking scenarios. + + +.. + TO REGENERATE THE GOLDEN MASTER FILE FOR THIS TEST: + + From the 'parameterized/' directory, run the following command: + + python minimal_parameterized_benchmark.py --rich-table.ops > minimal_parameterized_output.txt + + The --progress option is omitted here because it produces dynamic output + that changes as the benchmark runs and does not appear in the expected output file + when piped to a file instead of the terminal anyway. + + The doctests will verify that the output of the benchmark script matches the + format of the expected output: if the output format changes unexpectedly, + the doctest will fail. + + Doctests are run from the 'documentation/' directory, so paths in the test + configuration are relative to that directory: 'make doctest' handles this + automatically. + +.. testcode:: + :hide: + + # --- Test Configuration --- + # Paths are relative to the 'documentation/' directory. + + script_to_run = "tutorials/parameterized/multidimensional_parameterized_benchmark.py" + expected_output_file = "tutorials/parameterized/multidimensional_parameterized_output.txt" + script_args = ["--rich-table.ops"] + + # -------------------------- + + actual_output = run_script_and_get_raw_output( + script_path=script_to_run, + args=script_args + ) + assert_benchmark_output(actual_output, expected_output_file) \ No newline at end of file diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 0eb6624c..886ced12 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -311,6 +311,24 @@ dl.py.class dd dl.py.method dd dl.simple.field-list dt.field-odd { margin-top: .25rem } +/* field names for class parameters */ +dl.py.class dd dl.field-list.simple dd.field-odd ul.simple li p:first-child strong { + font-weight: bold; + color: #7b7b11; +} + +/* field names for method parameters */ +dl.py.class dd dl.py.method dd dl.simple.field-list dd.field-odd p:first-child strong { + font-weight: bold; + color: #7b7b11; +} + +/* field names for function parameters */ +dl.py.function dd dl.simple.field-list dd.field-odd ul.simple li p:first-child strong { + font-weight: bold; + color: #7b7b11; +} + /* Make field list terms for method 'raises' bold and not all uppercase */ dl.py.class dd dl.py.method dd dl.simple.field-list dt.field-even { text-transform: none; diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js index 1f7e5f04..8f6e8289 100644 --- a/docs/_static/documentation_options.js +++ b/docs/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '0.4.0-alpha.0', + VERSION: '0.4.1-alpha.0', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/command_line_options.html b/docs/command_line_options.html index 072575a1..140d22f4 100644 --- a/docs/command_line_options.html +++ b/docs/command_line_options.html @@ -3,16 +3,16 @@ - + - Command-Line Options - simplebench 0.4.0-alpha.0 documentation + Command-Line Options - simplebench 0.4.1-alpha.0 documentation - + @@ -164,7 +164,7 @@
            -
            simplebench 0.4.0-alpha.0 documentation
             +
            simplebench 0.4.1-alpha.0 documentation
            @@ -185,7 +185,7 @@
            - simplebench 0.4.0-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -200,7 +200,8 @@
        • Tutorials
        • Command-Line Options
          • @@ -483,14 +484,14 @@

          JSON Reports - +
          Previous
          -
          Basic Usage Tutorial
          +
          Parameterized Benchmark
           @@ -548,7 +549,7 @@

          JSON Reports +

        • diff --git a/docs/genindex.html b/docs/genindex.html index 6481b74a..7e25d23e 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -4,13 +4,13 @@ - Index - simplebench 0.4.0-alpha.0 documentation + Index - simplebench 0.4.1-alpha.0 documentation - + @@ -162,7 +162,7 @@
        -
        simplebench 0.4.0-alpha.0 documentation
         +
        simplebench 0.4.1-alpha.0 documentation
        @@ -183,7 +183,7 @@
        - simplebench 0.4.0-alpha.0 documentation + simplebench 0.4.1-alpha.0 documentation @@ -198,7 +198,8 @@
    • Tutorials
    • Command-Line Options
      • @@ -746,12 +747,12 @@

      C

  • CLI_ARGUMENTS_ERROR (simplebench.enums.ExitCode attribute)
    • - - + +
  • CSVField (class in simplebench.reporters.csv) + +
  • CSVOptions (class in simplebench) @@ -1031,6 +1040,20 @@

    E

    • + + - + - - - + +
  • MEAN (simplebench.reporters.csv.CSVField attribute) + +
  • mean (simplebench.stats.Stats property) @@ -1807,6 +1896,20 @@

    M

  • (simplebench.stats.stats.StatsSummary property)
  • (simplebench.stats.StatsSummary property) +
    • + +
  • MEDIAN (simplebench.reporters.csv.CSVField attribute) + +
  • median (simplebench.stats.Stats property) @@ -1851,6 +1954,20 @@

    M

    • +
  • MIN (simplebench.reporters.csv.CSVField attribute) + +
  • MIN_MEASURED_ITERATIONS (in module simplebench.defaults) @@ -2185,10 +2302,24 @@

    N