mllam/neural-lam

Add type hints to methods in interaction_net.py

Fermée

#448 ouverte le 20 mars 2026

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)Python (276 forks)auto 404
good first issuemaintenance

Métriques du dépôt

Stars
 (282 étoiles)
Métriques de merge PR
 (Merge moyen 56j 22h) (6 PRs mergées en 30 j)

Description

Summary

The methods in neural_lam/interaction_net.py currently lack type annotations. mypy is already configured in pre-commit but cannot fully validate this module without proper type hints.

Methods affected

  • InteractionNet.forward
  • InteractionNet.message
  • InteractionNet.aggregate
  • SplitMLPs.forward

Proposed Fix

Add torch.Tensor, Optional[torch.Tensor], Tuple and Union type hints to all method signatures and return types.

Why This Matters

  • mypy is already set up in .pre-commit-config.yaml
  • Type hints improve contributor experience and catch bugs early
  • Consistent with type hints already added in metrics.py (see #446)

Guide contributeur

Direction de recherche
Inspectez les annotations de type ajoutées dans metrics.py (PR #446) comme référence. Vérifiez la configuration mypy dans .pre commit config.yaml. Examinez les signatures des méthodes listées et ajoutez des annotations de type pour les arguments et les valeurs de retour.
Stack technique
pythonpytorch
Domaine
machine learning
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitPython
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85