Skip to content
This repository has been archived by the owner on Dec 20, 2024. It is now read-only.

Commit

Permalink
docs: update docs for release 0.4.1 (#99)
Browse files Browse the repository at this point in the history
* docs: include hierarchical processor
  • Loading branch information
JPXKQX authored and theissenhelen committed Dec 18, 2024
1 parent 65cd3c1 commit 4a99a5e
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/modules/models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,29 @@ 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:

0 comments on commit 4a99a5e

Please sign in to comment.