8000 docs: update docs for release 0.4.1 by JPXKQX · Pull Request #99 · ecmwf/anemoi-models · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
This repository was archived by the owner on Dec 20, 2024. It is now read-only.

docs: update docs for release 0.4.1 #99

Merged
merged 2 commits into from
Dec 16, 2024
Merged

docs: update docs for release 0.4.1 #99

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0e92a5
docs: include hierarchical processor
JPXKQX Dec 16, 2024
936630e
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/modules/models.rst
View file
Open in desktop
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_ 60EF 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:
Loading
0