Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add WarmupCosineAnnealingScheduler to NeuralLAM and add --steps keyword to training script #7

Open
wants to merge 17 commits into
base: dev/gefion
Choose a base branch
from

Conversation

matschreiner
Copy link

@matschreiner matschreiner commented Mar 5, 2025

This PR implements 2 features.

  1. A --steps argument has been added to the training script, allowing control over the number of training steps before termination. This is implemented using Trainer(..., max_num_steps=args.steps, ...) in pytorch_lightning. If both max_num_epochs and max_num_steps are specified in the Trainer, training will stop when either has been reached. By default "--steps" is -1 which means that without specifying this keyword, training will never terminate due to max_num_steps.

  2. A learning scheduler to NeuralLAM following the specifications given for learning rates in GraphCast at the developer meeting at DMI 4th of March. The defaults are implemented such that when using the default learning rate for Adam (1e-3) the linear warmup will range from epsilon to 1e-3 and then cosine annealing from 1e-3 to 1e-6. Otherwise, min and max learning rate will range from min_factor * initial_lr to max_factor * initial_lr)
    The signature and defaults of the scheduler is

neural_lam.lr_scheduler.WarmupCosineAnnealingLR(
        optimizer,
        warmup_steps=100000,
        annealing_steps=1000,
        max_factor=1.0,
        min_factor=0.001,
)

The scheduler has 3 phases:

Warmup phase

In this phase the learning rate is warmed up by linearly increasing the learning rate from min_factor * initial_learning_rate to max_factor * initial_learning_rate (The learning rate is defined in the optimizer).

Annealing phase

In this phase the learning rate is annealed by using a CosineAnnealing schedule that anneals the learning rate back to min_factor * initial_learning_rate by following a half a cosing cycle.

Fine tuning phase

In this phase the annealed learning rate is used until the training terminates.

Learning schedule

Using the default learning rate for the adam optimizer (1e-3), 20 warmup steps, 100 annealing steps and 150 steps in total will produce a schedule that looks as folllows:

WarmupCosineAnnealingLR(
        optimizer,
        warmup_steps=20,
        annealing_steps=100,
)

image

Type of change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📖 Documentation (Addition or improvements to documentation)

Checklist before requesting a review

  • My branch is up-to-date with the target branch - if not update your fork with the changes from the target branch (use pull with --rebase option if possible).
  • I have performed a self-review of my code
  • For any new/modified functions/classes I have added docstrings that clearly describe its purpose, expected inputs and returned values
  • I have placed in-line comments to clarify the intent of any hard-to-understand passages of my code
  • I have updated the README to cover introduced code changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have given the PR a name that clearly describes the change, written in imperative form (context).
  • I have requested a reviewer and an assignee (assignee is responsible for merging). This applies only if you have write access to the repo, otherwise feel free to tag a maintainer to add a reviewer and assignee.

Checklist for reviewers

Each PR comes with its own improvements and flaws. The reviewer should check the following:

  • the code is readable
  • the code is well tested
  • the code is documented (including return types and parameters)
  • the code is easy to maintain

Author checklist after completed review

  • I have added a line to the CHANGELOG describing this change, in a section
    reflecting type of change (add section where missing):
    • added: when you have added new functionality
    • changed: when default behaviour of the code has been changed
    • fixes: when your contribution fixes a bug

Checklist for assignee

  • PR is up to date with the base branch
  • the tests pass
  • author has added an entry to the changelog (and designated the change as added, changed or fixed)
  • Once the PR is ready to be merged, squash commits and merge the PR.

Type of change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📖 Documentation (Addition or improvements to documentation)

Checklist before requesting a review

  • My branch is up-to-date with the target branch - if not update your fork with the changes from the target branch (use pull with --rebase option if possible).
  • I have performed a self-review of my code
  • For any new/modified functions/classes I have added docstrings that clearly describe its purpose, expected inputs and returned values
  • I have placed in-line comments to clarify the intent of any hard-to-understand passages of my code
  • I have updated the README to cover introduced code changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have given the PR a name that clearly describes the change, written in imperative form (context).
  • I have requested a reviewer and an assignee (assignee is responsible for merging). This applies only if you have write access to the repo, otherwise feel free to tag a maintainer to add a reviewer and assignee.

Checklist for reviewers

Each PR comes with its own improvements and flaws. The reviewer should check the following:

  • the code is readable
  • the code is well tested
  • the code is documented (including return types and parameters)
  • the code is easy to maintain

Author checklist after completed review

  • I have added a line to the CHANGELOG describing this change, in a section
    reflecting type of change (add section where missing):
    • added: when you have added new functionality
    • changed: when default behaviour of the code has been changed
    • fixes: when your contribution fixes a bug

Checklist for assignee

  • PR is up to date with the base branch
  • the tests pass
  • author has added an entry to the changelog (and designated the change as added, changed or fixed)
  • Once the PR is ready to be merged, squash commits and merge the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant