Streamlitでの条件分岐処理について

Question

前提

STREAMLITを使って業務アプリを開発しています。

その中で、いわゆるプロセス処理前の入力条件を設定するＵＩの部分を書いています。

フロー

　入力条件は下記のように、逐次呼び出して設定される格好です（現時点は項目は不明のため、逐次思い付きで拡張しています）

1. 設定パラメータをボタンで呼び出す。
2. テキストボックスに設定条件を入れる。
3. 設定条件が内部ステータス変数に入る。

該当のソースコード

　実例はもう少し複雑で、一部割愛していますが、ソースコードをそのまま載せています。

• 予測モデル作成　→　セット名入力　→　ses.pathに設定
• tfidf_cutoffの変更　→　Tfidf閾値(default=10)を入力　→　コールバックでses.pathを保存　→　ses.cutoffに設定
• ses.pathが埋まっていたら　→　ses.path、ses.cutoffを表示　→　交差検証ボタン　　

という処理にしています。

import streamlit as st
import streamlit.components.v1 as stc
from streamlit import session_state as ses
from streamlit import sidebar as ssb


def keep_ses_path(path):
    ses.path = path

# mlFlowによる交差検証を実施するdataframeを保存する
if not 'choice_df' in ses:
    ses.choice_df = []

# mlFlowによる交差検証を実施するmodel=token名を保存する
if not 'path' in ses:
    ses.path = ''

if not 'cutoff' in ses:
    ses.cutoff = 10

if not 'df' in ses:
    ses.df = []

if not 'label' in ses:
    ses.label = []

if "source" in ses:
    ssb.write("データソース")
    ssb.code(ses.source)

    # ラベル選択widget表示
    df = ses['df']
    options = ssb.multiselect(
        '教師ラベル',
        ses['label'],
        default=ses['label'], key="option")

    if ssb.button("ラベル選択", key="selectlabel"):
        ses.choice_df = choice_df(df, ses.option)
        sum = sum_label(ses.choice_df)
        ssb.table(sum)

    if ssb.button("予測モデル作成"):
        if len(ses.choice_df)>0:
            ssb.text_input("セット名", placeholder=f"{options}", key="path")
        else:
            ssb.code("選択セットがありません")

    if ssb.button("tfidf_cutoffの変更", key ="cutoffb", on_click=keep_ses_path, args=(ses.path,)):
        ssb.text_input("Tfidf閾値(default=10)", placeholder=f"{ses.cutoff}",key="cutoff")

    if ses.path != "":
        ssb.write("モデル保存先")
        ssb.code(f"モデル {ses.path} ,Tfidf-cutoff {ses.cutoff}") 
      
        if ssb.button("交差検証実行", key="ml", on_click=ml_callback, kwargs={"token":ses.path, "df":ses.choice_df, "tfidf_cutoff":ses.cutoff}):
            ssb.write("交差検証を実行しました")

課題について

• CALLバックがないと、tfidf_cutoffの変更後に、ses.pathへの入力値がリセットされてしまいます。

→　 仕方がないので、callバック変数を使って、前の入力情報をもう一度、先に実行してステータスに退避することにしました。

• これで一応、やりたい機能は満たせていますが、パラメータはさらに拡張する可能性があります。

→　そのたびにコールバックを書いていくと、複雑なプログラムになってしまいそうです。

• 最終的には、Streamlitでプログラムを書くにあたり、これが正解なのかという疑問になりました。

→　何か定石というものがあれば、教えていただきたく思います。

Comments

[yuujiMotoki]

ソースに記載していませんでしたので改変しました。
sesという変数が、session_stateのエイリアスになっていますので、すでに実施しています。

少し不明な部分なのですが、st.text_input( key= "xxxx") という風に、テキストボックスにstatusを持たせてしまっていることが原因なのでしょうか?
こちらをコールバックで飛ばして、別のステータス変数に格納すれば、うまくいく様な気がしてきました。

Answer 1

気になったので試してみたのですが、ウィジェットと紐づいたsession_stateは、そのウィジェットが表示されなかったときは消えてしまうような動作をしていますね。
(バグではなくて、仕様なんですかね・・・ ちょっとわからない)

少し不明な部分なのですが、st.text_input( key= "xxxx") という風に、テキストボックスにstatusを持たせてしまっていることが原因なのでしょうか?
こちらをコールバックで飛ばして、別のステータス変数に格納すれば、うまくいく様な気がしてきました。

ご自身で書かれているように、コールバックで別変数にセットすれば解決できるように思います。

もしくは、text_inputを消えないようにしたらよいので、表示したままでもよいなら、ボタンをやめてチェックボックスにするのが簡単な対応かと。
もしくは、ses.pathが空でない場合はtext_inputが表示されるようにif文の条件を変えるとかでしょうか。

    if ssb.button("予測モデル作成") or ses.path != '':
        if len(ses.choice_df)>0:
            ssb.text_input("セット名", placeholder=f"{options}", key="path")
        else:
            ssb.code("選択セットがありません")

Comments

[yuujiMotoki]

ありがとうございます。ウィジットに紐付けするためのkeyの使い方について、勉強してみました。結局はコールバックでkey自体を参照して、何かを設定するような一時的な使い方が、主体のようです。
https://docs.streamlit.io/library/api-reference/session-state

def form_callback():
st.write(st.session_state.my_slider)
st.write(st.session_state.my_checkbox)

with st.form(key='my_form'):
slider_input = st.slider('My slider', 0, 10, 5, key='my_slider')
checkbox_input = st.checkbox('Yes or No', key='my_checkbox')
submit_button = st.form_submit_button(label='Submit', on_click=form_callback)

Answer 2

何か定石というものがあれば、教えていただきたく思います。

セッションにデータを保持しておく手法が一般的かと思います。streamlitでも利用できます。
詳細はAdd statefulness to appsを参照ください。