graphorge.gnn_base_model.train.training.save_training_state

save_training_state(model, optimizer, epoch=None, is_best_state=False, is_remove_posterior=True)[source]

Save model and optimizer states at given training epoch.

Material patch model state file is stored in model_directory under the name < model_name >.pt or < model_name >-< epoch >.pt if epoch is known.

Material patch model state file corresponding to the best performance is stored in model_directory under the name < model_name >-best.pt or < model_name >-< epoch >-best.pt if epoch is known.

Optimizer state file is stored in model_directory under the name < model_name >_optim-< epoch >.pt.

Optimizer state file corresponding to the best performance is stored in model_directory under the name < model_name >_optim-best.pt or < model_name >_optim-< epoch >-best.pt if epoch is known.

Parameters:

  • model (torch.nn.Module) – Model.

  • optimizer (torch.optim.Optimizer) – PyTorch optimizer.

  • epoch (int, default=None) – Training epoch.

  • is_best_state (bool, default=False) – If True, save material patch model state file corresponding to the best performance instead of regular state file.

  • is_remove_posterior (bool, default=True) – Remove material patch model and optimizer state files corresponding to training epochs posterior to the saved state file. Effective only if saved epoch is known.