lru_cache_benchmark.py ドキュメント

概要

本プログラムは、Pythonの標準ライブラリである functools.lru_cache を利用した際の、実行速度、キャッシュヒット数、および実計算回数の変化を測定・比較するためのベンチマークスクリプトです。 浮動小数点数の入力値を特定の桁数で丸めてからキャッシュのキーとして扱うことで、意図的にキャッシュヒット率を上げ、計算の省略によるパフォーマンス向上効果(実行時間短縮)を評価します。

依存ライブラリ

本スクリプトはPythonの標準ライブラリのみを使用しており、外部パッケージのインストールは不要です。

  • argparse

  • functools

  • math

  • random

  • statistics

  • time

入出力仕様

  • 入力: コマンドライン引数に基づく一様乱数データ

  • 出力: 標準出力(コンソール)へ、各条件における処理のリクエスト回数、実際の計算回数、実行時間の中央値、キャッシュの統計情報、および速度向上倍率(スピードアップ)を表示します。

コマンドライン引数

実行時に以下のオプションを指定することで、ベンチマークの条件を変更可能です。

  • -n, --n

    • 一様乱数の個数を指定します(デフォルト: 100000)。

  • --decimals

    • キャッシュキーとして使用する際の小数点以下の丸め桁数を指定します(デフォルト: 3)。

  • --n-exp

    • 1回の評価(実計算)において、ダミーの重い処理として math.exp を呼び出す回数を指定します(デフォルト: 100)。

  • -r, --repeat

    • 実行時間の測定を繰り返す回数を指定します。この中から中央値が算出されます(デフォルト: 3)。

  • --seed

    • 乱数生成のシード値を指定します(デフォルト: 12345)。

実行例

以下のコマンドは、入力値の個数を \(100000\) 個、小数点以下 \(2\) 桁で丸め、ダミー計算として math.exp を \(500\) 回呼び出す条件でベンチマークを実行する例です。

python lru_cache_benchmark.py --n 100000 --decimals 2 --n-exp 500 --repeat 3

実行結果として、以下のような統計情報が標準出力に出力されます。

N=100,000, repeat=3, exp calls per evaluation=500
cache key: round(x, 2)

case                         requests  actual evaluations   median time
------------------------------------------------------------------------
no cache                      300,000             300,000     2.123456 s
lru_cache + rounded key       300,000                 101     0.034567 s

lru_cache info (one run): hits=99,899, misses=101, currsize=101
speedup (median): 61.43 x
checksums (not physically meaningful): 1718.28, 1718.28

処理の概要

  1. データ準備 乱数生成器を初期化し、区間 \([0, 1)\) の一様乱数を指定された個数生成します。

  2. キャッシュなし計算の測定 生成した乱数配列に対し、そのまま計算(重いダミー処理)を実行します。この際、指定された繰り返し回数だけ同じ処理を行い、実行時間の中央値を記録します。

  3. キャッシュあり計算の測定 実行前に必ず cache_clear() を呼び出し、空のキャッシュ状態から計測を開始します。 乱数配列の各要素を、指定された小数点以下桁数に丸め、それをキーとしてキャッシュ対象の計算関数を呼び出します。 同様に複数回実行し、実行時間の中央値を算出します。

  4. 結果の算出 キャッシュなしの実行時間と、キャッシュありの実行時間を比較し、速度の向上倍率を計算します。また、計算結果の整合性を簡易的に確認するため、処理結果の合計値(チェックサム)を出力します。