if文：return Trueやreturn Falseの使い方について

Question

前提・実現したいこと

TensorFlow2 TensorFlow&Keras対応 プログラミング実装ハンドブック P.338-340で質問があります。

以下のコードで書かれているif文のreturn Trueやreturn Falseの使い方がわかりません。
ループを抜ける操作に関わると思いますが、このような使い方は見たことがなくて、自分で色々調べてもわかりませんでした。
return True = break, return False = continueといった感じでしょうか？

よかったら教えていただけないでしょうか？
どこかに参考になるページがあったら、添付していただけないでしょうか？
よろしくお願いします。

該当のソースコード

'''
7.学習の進捗を監視し早期終了判定を行うクラス
'''
class EarlyStopping:
    def __init__(self, patience=10, verbose=0):
        '''
        Parameters:
            patience(int): 監視するエポック数(デフォルトは10)
            verbose(int): 早期終了の出力フラグ
                          出力(1),出力しない(0)        
        '''
        # インスタンス変数の初期化
        # 監視中のエポック数のカウンターを初期化
        self.epoch = 0
        # 比較対象の損失を無限大'inf'で初期化
        self.pre_loss = float('inf')
        # 監視対象のエポック数をパラメーターで初期化
        self.patience = patience
        # 早期終了メッセージの出力フラグをパラメーターで初期化
        self.verbose = verbose
        
    def __call__(self, current_loss):
        '''
        Parameters:
            current_loss(float): 1エポック終了後の検証データの損失
        Return:
            True:監視回数の上限までに前エポックの損失を超えた場合
            False:監視回数の上限までに前エポックの損失を超えない場合
        '''
        # 前エポックの損失より大きくなった場合
        if self.pre_loss < current_loss:
            # カウンターを1増やす
            self.epoch += 1
            # 監視回数の上限に達した場合
            if self.epoch > self.patience:
                # 早期終了のフラグが1の場合
                if self.verbose:
                    # メッセージを出力
                    print('early stopping')
                # 学習を終了するTrueを返す
                return True
        # 前エポックの損失以下の場合
        else:
            # カウンターを0に戻す
            self.epoch = 0
            # 損失の値を更新する
            self.pre_loss = current_loss
        
        # 監視回数の上限までに前エポックの損失を超えなければ
        # Falseを返して学習を続行する
        # 前エポックの損失を上回るが監視回数の範囲内であれば
        # Falseを返す必要があるので、return文の位置はここであることに注意
        return False

コード追加分

該当のソースコード

%%time
'''
8.モデルを生成して学習する
'''
from sklearn.utils import shuffle

# エポック数
epochs = 100
# ミニバッチのサイズ
batch_size = 64
# 訓練のステップ数
train_steps = len(x_train)*0.8 / batch_size
# 検証のステップ数
val_steps = len(x_train)*0.2 / batch_size
# 訓練と検証における損失と精度の推移を記録するdictオブジェクト
history = {'loss':[], 'accuracy':[],
           'val_loss':[], 'val_accuracy': []}

# 早期終了の判定を行うオブジェクトを生成
ers = EarlyStopping(patience=20, # 監視対象回数
                    verbose=1)   # 早期終了時にメッセージを出力

# 出力層10ニューロンのモデルを生成
model = CNN(10)

# ImageDataGeneratorを生成
datagen = keras.preprocessing.image.ImageDataGenerator(
    rescale=1.0/255.0,      # ピクセル値を255で割って正規化する
    validation_split=0.2,   # 20パーセントのデータを検証用にする
    rotation_range=15,      # 15度の範囲でランダムに回転させる
    width_shift_range=0.1,  # 横サイズの0.1の割合でランダムに水平移動
    height_shift_range=0.1, # 縦サイズの0.1の割合でランダムに垂直移動
    horizontal_flip=True,  # 水平方向にランダムに反転、左右の入れ替え
    zoom_range=0.2,         # ランダムに拡大
)

# 訓練データ用のジェネレーターを生成
training_generator = datagen.flow(x_train, t_train,
                                  batch_size=batch_size,
                                  subset='training')      # 訓練用のデータを生成
# 検証データ用のジェネレーターを生成
validation_generator = datagen.flow(x_train, t_train,
                                    batch_size=batch_size,
                                    subset='validation') # 検証用のデータを生成

# 学習を行う
for epoch in range(epochs):
    # 訓練時のステップカウンター  
    step_counter = 0  
    # 1ステップ毎にミニバッチで学習する
    for x_batch, t_batch in training_generator:
        # ミニバッチでバイアス、重みを更新
        train_step(x_batch, t_batch)
        step_counter += 1
        # すべてのステップが終了したらbreak
        if step_counter >= train_steps:
            break
    
    # 検証時のステップカウンター
    v_step_counter = 0
    # 検証データによるモデルの評価
    for x_val_batch, t_val_batch  in validation_generator:
        # 検証データのミニバッチで損失と精度を測定
        val_step(x_val_batch, t_val_batch)
        v_step_counter += 1
        # すべてのステップが終了したらbreak
        if v_step_counter >= val_steps:
            break
   
    # 訓練と検証における損失と精度の推移をhistoryに記録
    history['loss'].append(train_loss.result())
    history['accuracy'].append(train_acc.result())
    history['val_loss'].append(val_loss.result())
    history['val_accuracy'].append(val_acc.result())
    
    # 1エポックごとに結果を出力
    print('epoch({}) train_loss: {:.4} train_acc: {:.4}'
          'val_loss: {:.4} val_acc: {:.4}'.format(
              epoch+1,
              train_loss.result(), # 訓練データの損失を出力
              train_acc.result(),  # 訓練データの精度を出力
              val_loss.result(),   # 検証データの損失を出力
              val_acc.result()     # 検証データの精度を出力
              ))
    
    # 検証データの損失をEarlyStoppingオブジェクトに渡して早期終了を判定
    if ers(val_loss.result()):
        # 監視対象のエポックで損失が改善されなければ学習を終了
        break

試したこと

ここに問題に対して試したことを記載してください。

補足情報（FW/ツールのバージョンなど）

ここにより詳細な情報を記載してください。

Answer 1

EarlyStoppingは学習が進まなくなったところで止めるものです。
なので、EarlyStoppingクラスの__call__関数は学習が進んでいるか進んでいるかを判定する関数であり、return Trueとreturn Falseはそれぞれ結果として返しています。

おそらくこのクラスを呼び出して使っている部分で__call__関数がTrueを返した時点で学習が進んでいないと判断して、学習が止まるようになっているのだと思います。

if EarlyStopping.__call__:
  [学習を終了する処理]

Comments

[chronobcelp]

その通りでした。コードを追加しました。
if ers(val_loss.result()):
break
ここで、ers(val_loss.result())=Trueとなるまで、繰り返していたんですね。
ありがとうございました。