From 203c54b19ff57a319bd118869c21fbc08de47c60 Mon Sep 17 00:00:00 2001 From: Junaid Shah Date: Fri, 27 Feb 2026 22:15:04 +0530 Subject: [PATCH] docs: improve __init__ docstrings and parameter descriptions --- neural_lam/models/base_graph_model.py | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/neural_lam/models/base_graph_model.py b/neural_lam/models/base_graph_model.py index 35b1ab126..eb7b7a208 100644 --- a/neural_lam/models/base_graph_model.py +++ b/neural_lam/models/base_graph_model.py @@ -16,6 +16,21 @@ class BaseGraphModel(ARModel): """ def __init__(self, args, config: NeuralLAMConfig, datastore: BaseDatastore): + """ + Initializes the BaseGraphModel for graph-based weather forecasting. + + This constructor loads the graph structure, registers static features as buffers, + initializes MLP embedders for grid and mesh nodes, and sets up the + Encoder-Processor-Decoder GNN architecture. + + Args: + args (Namespace): Command-line arguments containing hyperparameters like + hidden_dim and hidden_layers. + config (NeuralLAMConfig): Configuration object containing training and + model settings. + datastore (BaseDatastore): Datastore instance to handle data loading + and graph paths. + """ super().__init__(args, config=config, datastore=datastore) # Load graph with static features