StreamlitのCache機能の解説

はじめに

本記事では'Streamlit'にで実装されているオンメモリキャッシュ機能であるst.cacheについての解説を行います。 st.cacheを活用することで処理の重いグラフの描写などの処理を高速化することができるなど、Streamlitアプリケーションのパフォーマンス最適化を行ううえでもっとも重要な機能となっています。

使い方

Cacheを有効にする方法はとても簡単です。st.cacheで対象の関数をデコレートするだけで有効化されます。例として以下のように書くことができます。

import streamlit as st
import time


@st.cache
def expensive_computation(a, b):
    time.sleep(2)  # This makes the function take 2s to run
    return a * b


a = 2
b = 21

start = time.time()
res = expensive_computation(a, b)
st.write("Result:", res)
print(time.time() - start)

st.cacheは関数の入力と出力をkeyとvalueのペアでメモリ上に保持しておき、同じ入力が与えられたときにはメモリ上のキャッシュから値を返します。このとき、関数の中身は実行さないため高速化されると言う話です。この機能を使うとページをリロードしたときの読み込みなどを高速化することができます。 上のコードを実行すると、最初の読み込みでは2秒かかっているものがページをリロードする高速化されていることがわかるかと思います。筆者の環境では0.1秒程度になっていました。

パラメータ

st.cacheには指定できるパラメータがいくつかあるので紹介したいと思います。

suppress_st_warning （bool）

Trueを指定するとデコレートされた関数で起きるcache関係の警告を無視することができます。 Streamlitの警告はUIに直接表示されてしまうので無視したい場合はTrueにすることで回避できます。

例えば、以下の例では、"Cache miss:..."の部分は2度目以降は表示されないので通常は警告が出ますが、suppress_st_warning=Trueで警告を表示しないようにしています。

import streamlit as st
import time

@st.cache(suppress_st_warning=True)
def expensive_computation(a, b):
    st.write("Cache miss: expensive_computation(", a, ",", b, ") ran")
    time.sleep(2)  # This makes the function take 2s to run
    return a * b

a = 2
b = 21
res = expensive_computation(a, b)

st.write("Result:", res)

allow_output_mutation （bool）

基本的にキャッシュされた値はイミュータブルですが、allow_output_mutation=Trueとすることでミュータブルにすることができます。 以下の例ではキャッシュされたresに対して変更を加えていますが、allow_output_mutationとすることでエラーなく実行できます。

import streamlit as st
import time

@st.cache(allow_output_mutation=True)
def expensive_computation(a, b):
    st.write("Cache miss: expensive_computation(", a, ",", b, ") ran")
    time.sleep(2)  # This makes the function take 2s to run
    return a * b

a = 2
b = 21
res = expensive_computation(a, b)

res = res + 30
st.write("Result:", res)

hash_func （Callable）

st.cacheでは関数への入力をハッシュ化してKeyとしてメモリ上で保持します。デフォルトでは入力値の構造を再帰的にハッシュ化していくのですが、hash_funcに指定した関数でハッシュ化の方法をカスタマイズできます。

用途としては、以下の例がわかりやすいのです。この例では、デフォルトだとFileReferenceが参照しているファイル名でハッシュ化を行うところ、ファイル名とファイルが変更された日付での両方でハッシュ化を行なっています。

class FileReference:
    def __init__(self, filename):
        self.filename = filename

def hash_file_reference(file_reference):
    filename = file_reference.filename
    return (filename, os.path.getmtime(filename))

@st.cache(hash_funcs={FileReference: hash_file_reference})
def func(file_reference):
    ...

persist （bool）

オンメモリからディスクキャッシュへと変更ができます。

max_entries (Optional[int])

キャッシュ可能なエントリー数です。デフォルトはNoneとなっており、よほどメモリを使うようなキャッシュでない限り指定する必要はありません。

参照

• st.cache - Streamlit Docs