Colab + PyTorch Lightning + Comet ML

背景

Kaggle の上位ランカーが PyTorch Lightning について言及していたの試してみる。同様に Comet ML も。Kaggle の試行錯誤を Colab (or Colab Pro) に移行できるかもあわせて検討する。

ToDO

以下淡々と ToDOをこなしていきメモを残す。

Lightning 基礎

Lightning の transformers example を Colab 単体で動かす。
上記の dataloader を少ないデータに改造 end to end で素早く回せるようにする。

Lightning training resume

Checkpointing によると2つ方法がある。

1つめ

Trainer の resume_from_checkpoint 引数で checkpoint のパスを指定する。

resume = False
if resume:
  trainer = pl.Trainer(gpus=1,
                                    max_epochs=4,
                                    resume_from_checkpoint='lightning_logs/version_0/checkpoints/_ckpt_epoch_1.ckpt')  
else:
  !rm -rf lightning_logs/  
  trainer = pl.Trainer(gpus=1, max_epochs=2)

trainer.fit(bert_finetuner)

まず最初の training 時には以下のようなログ。

Epoch 1: 100%|██████████| 4/4 [00:01<00:00,  2.22batch/s, avg_val_acc=0.2, batch_idx=2, gpu=0, loss=1.138, v_num=0, val_loss=1.12]
Epoch 2: 100%|██████████| 4/4 [00:29<00:00,  7.26s/batch, avg_val_acc=0.2, batch_idx=2, gpu=0, loss=1.084, v_num=0, val_loss=1.08]

次に resume すると

Epoch 2: 100%|██████████| 4/4 [00:01<00:00,  2.22batch/s, avg_val_acc=0.6, batch_idx=2, gpu=0, loss=0.992, v_num=1, val_loss=0.916]
Epoch 3: 100%|██████████| 4/4 [00:01<00:00,  2.34batch/s, avg_val_acc=0.6, batch_idx=2, gpu=0, loss=0.952, v_num=1, val_loss=0.844]
Epoch 4: 100%|██████████| 4/4 [00:05<00:00,  1.14s/batch, avg_val_acc=0.8, batch_idx=2, gpu=0, loss=0.911, v_num=1, val_loss=0.751]
Epoch 5: 100%|██████████| 4/4 [00:31<00:00,  7.86s/batch, avg_val_acc=1, batch_idx=2, gpu=0, loss=0.865, v_num=1, val_loss=0.659]

training をresumeできる。ただし Epoch 2 を2回やっているように見える。注意しないといけないのは dataloader は state が resume されるわけではないこと。なので shuffle 前提であるとどこかに書いてあった。

2つめ

experiment version 番号を使う方法。experiment version については、pytorch_lightning.loggers.tensorboard moduleの version 引数に説明がある。version は上記のversion_0 とか version_1 が自動で割り振られるをやめて特定の物を指定する。

コードは

from pytorch_lightning.logging.tensorboard import TensorBoardLogger
bert_finetuner = BertMNLIFinetuner()

resume = False # True

logger = TensorBoardLogger(save_dir='experiments', version=10)
if resume:
  trainer = pl.Trainer(gpus=1, max_epochs=5, logger=logger)
else:
  !rm -rf default/version_10/  
  trainer = pl.Trainer(gpus=1, max_epochs=2, logger=logger)
trainer.fit(bert_finetuner)

Train 開始。

Epoch 1: 100%|██████████| 4/4 [00:02<00:00,  1.49batch/s, avg_val_acc=0, batch_idx=2, gpu=0, loss=1.122, v_num=10, val_loss=1.26]
Epoch 2: 100%|██████████| 4/4 [00:29<00:00,  7.35s/batch, avg_val_acc=0.2, batch_idx=2, gpu=0, loss=1.032, v_num=10, val_loss=1.18]

Train resume。

INFO:root:model and trainer restored from checkpoint: /content/default/version_10/checkpoints/_ckpt_epoch_1.ckpt
Epoch 2: 100%|██████████| 4/4 [00:01<00:00,  1.54batch/s, avg_val_acc=1, batch_idx=2, gpu=0, loss=0.844, v_num=10, val_loss=0.56]
Epoch 3:  75%|███████▌  | 3/4 [00:01<00:00,  1.54batch/s, avg_val_acc=1, batch_idx=2, gpu=0, loss=0.767, v_num=10, val_loss=0.56]
Epoch 3: 100%|██████████| 4/4 [00:02<00:00,  1.54batch/s, avg_val_acc=1, batch_idx=2, gpu=0, loss=0.767, v_num=10, val_loss=0.446]
Epoch 4: 100%|██████████| 4/4 [00:05<00:00,  1.54batch/s, avg_val_acc=1, batch_idx=2, gpu=0, loss=0.696, v_num=10, val_loss=0.356]
Epoch 5: 100%|██████████| 4/4 [00:31<00:00,  7.81s/batch, avg_val_acc=1, batch_idx=2, gpu=0, loss=0.619, v_num=10, val_loss=0.287]

こちらの方法が自動的に新しい version が振られることなく自然で使いやすいと思う。

Google Drive への保存

Colab はいつセッションが切れるか分からないので Google Drive に保存する。以下のようなコードで Google Drive がマウントされていない場合のみにマウント処理。

from google.colab import drive
from pathlib import Path

def mount_drive_if_necessary():
    drive_path = Path('/content/drive')
    if not drive_path.exists():
      drive.mount(str(drive_path))

mount_drive_if_necessary()

train のコードは

from pytorch_lightning.logging.tensorboard import TensorBoardLogger
bert_finetuner = BertMNLIFinetuner()

resume = True

save_root_path = Path('/content/drive/My Drive/kaggle/tf2.0')
logger = TensorBoardLogger(save_dir= save_root_path / 'logs', version=10, name='simple_bert')
if resume:
  trainer = pl.Trainer(gpus=1, max_epochs=5, logger=logger, default_save_path=save_root_path)
else:
  !rm -rf default/version_10/  
  trainer = pl.Trainer(gpus=1, max_epochs=2, logger=logger, default_save_path=save_root_path)

trainer.fit(bert_finetuner)

実際の check points と log は以下のように保存される。

/content/drive/My Drive/kaggle/tf2.0
/content/drive/My Drive/kaggle/tf2.0/logs
/content/drive/My Drive/kaggle/tf2.0/logs/simple_bert
/content/drive/My Drive/kaggle/tf2.0/logs/simple_bert/version_10
/content/drive/My Drive/kaggle/tf2.0/logs/simple_bert/version_10/events.out.tfevents.1582691888.8883d33e5953.1505.0
/content/drive/My Drive/kaggle/tf2.0/logs/simple_bert/version_10/meta_tags.csv
/content/drive/My Drive/kaggle/tf2.0/logs/simple_bert/version_10/events.out.tfevents.1582692040.8883d33e5953.1505.1
/content/drive/My Drive/kaggle/tf2.0/simple_bert
/content/drive/My Drive/kaggle/tf2.0/simple_bert/version_10
/content/drive/My Drive/kaggle/tf2.0/simple_bert/version_10/checkpoints
/content/drive/My Drive/kaggle/tf2.0/simple_bert/version_10/checkpoints/_ckpt_epoch_1.ckpt
/content/drive/My Drive/kaggle/tf2.0/simple_bert/version_10/checkpoints/_ckpt_epoch_4.ckpt

ハイパーパラメータを checkpoint と同時に保存する

以下のような警告が出ているので調べる。

UserWarning: Did not find hyperparameters at model.hparams. Saving checkpoint without hyperparameters
  "Did not find hyperparameters at model.hparams. Saving checkpoint without"

hparams が checkpoint と一緒に保存されてうれしいのは load_from_checkpoint で load するとき。Trainer 経由で resume するときはその限りではない気がする。ちなみに hparams はモデルで

class BertMNLIFinetuner(pl.LightningModule):

    def __init__(self, hparams):
        super(BertMNLIFinetuner, self).__init__()
        
        self.bert = bert
        self.W = nn.Linear(bert.config.hidden_size, 3)
        self.num_classes = 3
        self.hparams = hparams
        self.learning_rate = hparams.learning_rate

...snip...
hparams = Namespace(**{'learning_rate': 2e-05})

bert_finetuner = BertMNLIFinetuner(hparams)

こうすることで hparams が別ファイルとして保存される。

! cat tf2.0/logs/simple_bert/version_10/meta_tags.csv
key,value
learning_rate,2e-05

この hparams と comet.ml などの連携も調べなければいけない。

Comet ML

以下のように Trainer に CometLogger を渡せばOK。オフラインモードはインターネット接続がない環境向けなので使わない。

comet_logger = CometLogger(
    api_key='',
    workspace='higepon',
    project_name="simple-bert-test", # Optional
    experiment_name="my_experiment_name_long7",
    rest_api_key = '')

trainer = pl.Trainer(gpus=1, max_epochs=30, logger=comet_logger, default_save_path=save_root_path)

Code タブ

各 Experiment ごとにソースコードを紐付けることができる。そうすれば各バージョンごとに Diff がとれるようになる。Colab の場合以下のようにソースコードを Comet に送る。

code = ''
for cell_in in In:
  code += cell_in + '\n'

comet_logger.experiment.set_code(code)

f:id:higepon:20200227154801p:plain

Metrics を追加する

デフォルトでは train loss しか Comet で見ることができない。自分の場合は val loss も欲しかったので以下のようにした。

    def validation_end(self, outputs):
        avg_loss = torch.stack([x['val_loss'] for x in outputs]).mean()
        avg_val_acc = torch.stack([x['val_acc'] for x in outputs]).mean()

        tensorboard_logs = {'val_loss': avg_loss, 'avg_val_acc': avg_val_acc}
        self.logger.experiment.log_metric('val_loss', avg_loss.detach().cpu().numpy(), step=self.global_step, epoch=self.current_epoch, include_context=True)
        return {'avg_val_loss': avg_loss, 'progress_bar': tensorboard_logs}

training の resume

CometLogger は training の resume に対応していないことがわかった（pytorch-lightning/comet.py)。というか TensorboardLogger が resume に対応しているのだね。つまり Lightning と Comet を同時に使いたいなら CometLogger 経由ではなく Comet API を直接叩くのが良さそう。

存在する experiment に追記できてる？

Experiment Overview - Comet.ml よると experiment.get_key(self) を利用して ExistingExperiment を作れる。実際に試してみたらうまく行った。

if resume:
   experiment = comet_ml.ExistingExperiment(api_key='',
                                            previous_experiment=experiment_key,
                                      project_name="simple-bert-test",
                                      workspace='higepon',
                                      ) 
else:
  experiment = comet_ml.Experiment(api_key='',
                                      project_name="simple-bert-test",
                                      workspace='higepon',
                                      )

apex amp を有効にする

Trainer に use_amp=True を渡す。Colab で環境を整えるのはちょっと面倒。

try:
  from apex import amp
except ImportError:
  !pip install https://download.pytorch.org/whl/cu100/torch-1.2.0-cp36-cp36m-manylinux1_x86_64.whl
  !pip install https://download.pytorch.org/whl/cu100/torchvision-0.4.0-cp36-cp36m-manylinux1_x86_64.whl    
  !git clone https://github.com/NVIDIA/apex
  !cd apex;pip3 install -v --no-cache-dir --global-option="--cpp_ext" --global-option="--cuda_ext" .

! pip -q install pytorch-lightning==0.6.0
! pip -q install transformers==2.1.1
! pip -q install comet_ml

続きます。