lru_cache_benchmark.py ドキュメント

概要

本プログラムは、Pythonの標準ライブラリである functools.lru_cache を利用した際の、関数の実行時間、キャッシュヒット数、および実際の計算回数を比較するベンチマークスクリプトです。浮動小数点数の入力を特定の桁数で丸めることでキャッシュのヒット率を意図的に高め、キャッシュを利用しない場合とのパフォーマンスの差を測定します。

特徴

  • 乱数として生成された浮動小数点数に対して、重い計算処理( math.exp の繰り返し呼び出し)を実行します。

  • 入力値を丸め処理( round )してから lru_cache に渡すことで、連続値に対するキャッシュ効果を検証します。

  • キャッシュ利用時の計測では、毎回の反復前に cache_clear を呼び出し、キャッシュ構築時間も含めた公平なベンチマークを行います。

  • 複数回の計測を行い、その中央値(median)を実行時間として採用します。

動作原理

本プログラムはキャッシュの効果を検証するベンチマークツールであり、物理的・数学的なシミュレーションは行いません。 動作の基本フローは以下の通りです。

  1. コマンドライン引数から指定された数 \(N\) 個の、\(0\) から \(1\) の範囲の一様乱数を生成します。

  2. キャッシュを利用しない関数( costly_exp_plain )を用いて、すべての乱数に対して指定回数分の math.exp を計算し、時間を計測します。

  3. キャッシュを利用する関数( costly_exp_cached )に対し、入力の乱数を指定された小数点以下桁数に丸めた上で適用し、計算時間を計測します。

  4. 両者の実行時間の中央値、呼び出し回数、キャッシュのヒット情報を標準出力に表示します。

依存関係

本プログラムはPython標準ライブラリのみで構成されており、非標準ライブラリへの依存はありません。

  • argparse

  • functools

  • math

  • random

  • statistics

  • time

入出力仕様

入力

本プログラムはコマンドライン引数からパラメータを受け取ります。

  • -n, --n : 一様乱数の個数を指定します(デフォルト: 100000)。正の整数である必要があります。

  • --decimals : キャッシュキーとして使用する丸め処理の小数点以下桁数を指定します(デフォルト: 3)。\(0\) 以上の整数である必要があります。

  • --n-exp : 1回の関数呼び出し内で実行する math.exp(x) の繰り返し回数を指定します(デフォルト: 100)。計算の重さを調整するためのパラメータです。正の整数である必要があります。

  • -r, --repeat : 実行時間を測定するための繰り返し回数を指定します(デフォルト: 3)。正の整数である必要があります。

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

出力

ベンチマークの実行結果が標準出力(コンソール)にテキスト形式で表示されます。 出力される情報は以下の通りです。

  • 指定されたパラメータの確認情報

  • キャッシュなし、およびキャッシュありそれぞれの、リクエスト総数、実際の計算実行回数、実行時間の中央値(秒)

  • キャッシュのヒット数( hits )、ミス数( misses )、キャッシュサイズ( currsize )

  • 高速化の倍率( speedup )

  • 正しく計算が実行されたかを確認するためのチェックサム値

実行例

デフォルトのパラメータで実行する場合は、以下のコマンドを使用します。

python lru_cache_benchmark.py

各種パラメータを指定して実行する場合の例です。乱数の数を \(50000\) 、小数点以下 \(2\) 桁で丸め、1回あたりの内部ループを \(50\) 回、繰り返し測定を \(5\) 回行います。

python lru_cache_benchmark.py --n 50000 --decimals 2 --n-exp 50 -r 5