Zenn
👋

%timeitの測定結果を処理する

2022/11/19に公開
Python
pandas
numpy
パフォーマンス計測
tech

概要

ipython notebookで%timeitの測定結果を分析する際、結果をpythonの変数から参照したくなる。ドキュメント[1]によれば、-oオプションをつけると取得できる。この記事では結果の処理方法を計測例とともに説明する。

TimeitResult オブジェクトの構造

result = %timeit -o [i ** 2 for i in range(10_000)]

resultはTimeitResultクラスのオブジェクト[2]。ドキュメントによると、以下のような属性を持つ[3]。

  • loops: 1回の計測における対象の処理の反復回数
  • repeat: 計測回数
  • best: 最も良かった測定結果
  • worst: 最も悪かった測定結果
  • all_runs: 各計測にかかった時間（単位: 秒）
  • compile_time: 式のコンパイルにかかった時間（単位: 秒）
  • average(readonly): 測定結果の平均値
  • srdev(readonly): 測定結果の分散

注意すべきなのは、all_runsの結果はloop回の合計値であること。all_runsの結果から1回あたりの処理時間を計算するには、loop回数で割る必要がある。

平均値 v.s. 最小値

なお、平均値や分散を計算しているが、timeit.Timer.repeatのドキュメント[4]によると、

注釈 結果のベクトルから平均値や標準偏差を計算して出力させたいと思うかもしれませんが、それはあまり意味がありません。多くの場合、最も低い値がそのマシンが与えられたコード断片を実行する場合の下限値です。結果のうち高めの値は、Python のスピードが一定しないために生じたものではなく、その他の計測精度に影響を及ぼすプロセスによるものです。したがって、結果のうち min() だけが見るべき値となるでしょう。この点を押さえた上で、統計的な分析よりも常識的な判断で結果を見るようにしてください。

とある。つまり時間が伸びるのは外乱が原因であることがほとんどなので最小値以外は見る必要がないとのこと。したがって以下の計測例では最小値のみをプロットしている。
おそらく平均や分散をとって意味があるのは計測対象の処理時間が確率的に変動するような特殊なケースだろう（例：処理するデータがランダムに変わるなど）。

計測例

実際に計測してみる。以下の5通りの書き方でfilter処理の速度を比較する。

  1. result[:] = filter(<filter_func>, xs)
  2. result[:] = (x for x in xs if <filter_cond>)
  3. result[:] = [x for x in xs if <filter_cond>]
  4. result = xs[<filter_cond>] (xs: numpy.array)
  5. result = xs[<filter_cond>] (xs: pandas.DataFrame)

計測のコード

%load_ext lab_black

import numpy as np
import pandas as pd
import matplotlib.pyplot as plt

plt.style.use("ggplot")

sim_result = {}
N = 100_000

# filter
xs = np.random.randint(0, 256, N)
result = []
sim_result["filter"] = %timeit -o result[:] = filter(lambda x: x > 128, xs)

# tuple comprehension
xs = np.random.randint(0, 256, N)
result = []
sim_result["tuple comp."] = %timeit -o result[:] = (x for x in xs if x > 128)

# list comprehension
xs = np.random.randint(0, 256, N)
result = []
sim_result["list comp."] = %timeit -o result[:] = [x for x in xs if x > 128]

# filter with numpy
xs = np.random.randint(0, 256, N)
sim_result["numpy"] = %timeit -o result = xs[xs > 128]

# pandas
xs = pd.DataFrame(np.random.randint(0, 256, N))
sim_result["pandas"] = %timeit -o result = xs[xs > 128]

data = []
for name, result in sim_result.items():
    data.append(
        {
            "name": name,
            "min": result.best,
            "loops": result.loops,
            "repeat": result.repeat,
        }
    )
data = pd.DataFrame(data)
data
name min loops repeat
filter 0.004643 100 7
tuple comp. 0.003821 100 7
list comp. 0.003619 100 7
numpy 0.000331 1000 7
pandas 0.000599 1000 7 
_, ax = plt.subplots(figsize=(8, 3))
ax.bar(data["name"], data["mean"], yerr=data["std"], ecolor="black", capsize=10)
ax.set(xlabel="algorithm", ylabel="Execution Time (sec)")
plt.show()

result

という感じでいい感じにグラフにすることができた。

脚注

  1. https://ipython.readthedocs.io/en/stable/interactive/magics.html#magic-timeit ↩︎

  2. IPython.core.magics.execution.TimeitResultをインポートしてhelp()にかければわかる。もっと簡単には、resultオブジェクトをhelp()にかければわかる。 ↩︎

  3. 変数の意味はともかく何が格納されているかを知りたければvars(result)で属性を列挙すればわかる。 ↩︎

  4. https://docs.python.org/ja/3/library/timeit.html#timeit.Timer.repeat ↩︎

GitHubで編集を提案

Discussion