Skip to content

Add type hints to all functions in metrics.py #446#447

Open
Sidhant185 wants to merge 1 commit intomllam:mainfrom
Sidhant185:feat/add-type-hints-metrics
Open

Add type hints to all functions in metrics.py #446#447
Sidhant185 wants to merge 1 commit intomllam:mainfrom
Sidhant185:feat/add-type-hints-metrics

Conversation

@Sidhant185
Copy link
Copy Markdown

@Sidhant185 Sidhant185 commented Mar 20, 2026

Describe your changes

Add torch.Tensor, Optional[torch.Tensor] and bool type hints to all
function signatures and return types in neural_lam/metrics.py.

Functions updated:

  • get_metric
  • mask_and_reduce_metric
  • wmse, mse, wmae, mae, nll, crps_gauss

No logic changes were made — only type annotations were added.

Issue Link

closes #446

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
  • 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
  • I have requested a reviewer and an 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:
    • maintenance: add type hints to all functions in metrics.py

Checklist for assignee

  • PR is up to date with the base branch
  • the tests pass
  • (if the PR is not just maintenance/bugfix) the PR is assigned to the next milestone. If it is not, propose it for a future milestone.
  • author has added an entry to the changelog (and designated the change as added, changed, fixed or maintenance)
  • Once the PR is ready to be merged, squash commits and merge the PR.

@Sidhant185 Sidhant185 changed the title Add type hints to all functions in metrics.py Add type hints to all functions in metrics.py #446 Mar 20, 2026
@sadamov sadamov self-requested a review March 23, 2026 05:34
@sadamov sadamov added the enhancement New feature or request label Mar 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add type hints to functions in metrics.py

2 participants