mllam/neural-lam

Add type hints to methods in interaction_net.py

Aperta

#448 aperta il 20 mar 2026

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Python (276 fork)auto 404
good first issuemaintenance

Metriche repository

Star
 (282 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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)

Guida contributor

Direzione di ricerca
Esamina i suggerimenti di tipo aggiunti in metrics.py (PR #446) come riferimento. Controlla le impostazioni di mypy in .pre commit config.yaml. Esamina le firme dei metodi elencati e aggiungi annotazioni di tipo per argomenti e valori di ritorno.
Tech stack
pythonpytorch
Dominio
machine learning
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitPython
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85