NAME

Bencher::Scenario::Games::Wordlist::startup - Benchmark startup overhead of Games::Word::Wordlist::* modules

VERSION

This document describes version 0.051 of Bencher::Scenario::Games::Wordlist::startup (from Perl distribution Bencher-Scenarios-Games-Wordlist), released on 2022-03-20.

SYNOPSIS

To run benchmark with default option:

% bencher -m Games::Wordlist::startup

For more options (dump scenario, list/include/exclude/add participants, list/include/exclude/add datasets, etc), see bencher or run bencher --help.

DESCRIPTION

Packaging a benchmark script as a Bencher scenario makes it convenient to include/exclude/add participants/datasets (either via CLI or Perl code), send the result to a central repository, among others . See Bencher and bencher (CLI) for more details.

BENCHMARKED MODULES

Version numbers shown below are the versions used when running the sample benchmark.

Games::Word::Wordlist::Enable 2010090401

Games::Word::Wordlist::SGB 2010091501

BENCHMARK PARTICIPANTS

SAMPLE BENCHMARK RESULTS

Run on: perl: v5.34.0, CPU: Intel(R) Core(TM) i5-7200U CPU @ 2.50GHz (2 cores), OS: GNU/Linux Ubuntu version 20.04, OS kernel: Linux version 5.4.0-91-generic.

Benchmark with default options (bencher -m Games::Wordlist::startup):

#table1#
+-------------------------------+-----------+-------------------+-----------------------+-----------------------+---------+---------+
| participant                   | time (ms) | mod_overhead_time | pct_faster_vs_slowest | pct_slower_vs_fastest |  errors | samples |
+-------------------------------+-----------+-------------------+-----------------------+-----------------------+---------+---------+
| Games::Word::Wordlist::Enable |     30.6  |             24.72 |                 0.00% |               420.93% | 1.4e-05 |      20 |
| Games::Word::Wordlist::SGB    |     30.6  |             24.72 |                 0.21% |               419.83% |   1e-05 |      20 |
| perl -e1 (baseline)           |      5.88 |              0    |               420.93% |                 0.00% | 4.5e-06 |      20 |
+-------------------------------+-----------+-------------------+-----------------------+-----------------------+---------+---------+

Formatted as Benchmark.pm result:

                         Rate  GWW:E  GWW:S  perl -e1 (baseline) 
 GWW:E                 32.7/s     --     0%                 -80% 
 GWW:S                 32.7/s     0%     --                 -80% 
 perl -e1 (baseline)  170.1/s   420%   420%                   -- 

Legends:
  GWW:E: mod_overhead_time=24.72 participant=Games::Word::Wordlist::Enable
  GWW:S: mod_overhead_time=24.72 participant=Games::Word::Wordlist::SGB
  perl -e1 (baseline): mod_overhead_time=0 participant=perl -e1 (baseline)

To display as an interactive HTML table on a browser, you can add option --format html+datatables.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Bencher-Scenarios-Games-Wordlist.

SOURCE

Source repository is at https://github.com/perlancar/perl-Bencher-Scenarios-Games-Wordlist.

SEE ALSO

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2022, 2017, 2016 by perlancar <perlancar@cpan.org>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Bencher-Scenarios-Games-Wordlist

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.