From e0e92a5e6c78e209cf0c3ab147ccf85284c7e41c Mon Sep 17 00:00:00 2001 From: Mario Santa Cruz Date: Mon, 16 Dec 2024 14:58:57 +0000 Subject: [PATCH] docs: include hierarchical processor --- docs/modules/models.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docs/modules/models.rst b/docs/modules/models.rst index 392a9d61..1bf1ed5d 100644 --- a/docs/modules/models.rst +++ b/docs/modules/models.rst @@ -13,3 +13,26 @@ encoder, processor, and decoder. :members: :no-undoc-members: :show-inheritance: + + +********************************************** + Encoder Hierarchical processor Decoder Model +********************************************** + +This model extends the standard encoder-processor-decoder architecture by introducing a **hierarchical processor**. + +Compared to the AnemoiModelEncProcDec model, this architecture requires a predefined list of +hidden nodes, `[hidden_1, ..., hidden_n]`. These nodes must be sorted to match the expected +flow of information `data -> hidden_1 -> ... -> hidden_n -> ... -> hidden_1 -> data`. + +A new argument is added to the configuration file: `enable_hierarchical_level_processing`. This argument determines +whether a processor is added at each hierarchy level or only at the final level. + +By default, the number of channels for the mappers is defined as `2^n * config.num_channels`, where `n` represents the +hierarchy level. This scaling ensures that the processing capacity grows proportionally with the depth of the +hierarchy, enabling efficient handling of data. + +.. automodule:: anemoi.models.models.hierarchical + :members: + :no-undoc-members: + :show-inheritance: