Docstring done

MeteoSwiss · Dec 18, 2024 · 18e9a75 · 18e9a75
1 parent 8602b15
commit 18e9a75
Showing 1 changed file with 30 additions and 2 deletions.
diff --git a/docs/graphs/edge_attributes.rst b/docs/graphs/edge_attributes.rst
@@ -67,10 +67,25 @@ edge.
        target_name: ...
        edge_builders: ...
        attributes:
-          attribute_name:
+          comes_from_source_node:
             _target_: anemoi.graphs.edges.attributes.AttributeFromSourceNode
             node_attr_name: "attribute_name"
 
+
+Example usage for copying the cutout mask from nodes to edges in the encoder: 
+
+.. code:: yaml
+  edges:
+    # Encoder
+  - source_name: data
+    target_name: hidden
+    edge_builders: ...
+    attributes: 
+      cutout: 
+        _target_: anemoi.graphs.edges.attributes.AttributeFromSourceNode
+        node_attr_name: cutout
+
+
 *************
  From Target
 *************
@@ -85,6 +100,19 @@ edge.
        target_name: ...
        edge_builders: ...
        attributes:
-         attribute_name:
+         comes_from_target_node:
             _target_: anemoi.graphs.edges.attributes.AttributeFromTargetNode
             node_attr_name: "attribute_name"
+
+Example usage for copying the coutout mask from nodes to edges in the decoder: 
+
+.. code:: yaml
+  edges:
+    # Decoder
+  - source_name: hidden
+    target_name: data
+    edge_builders: ...
+    attributes: 
+      cutout: 
+        _target_: anemoi.graphs.edges.attributes.AttributeFromTargetNode
+        node_attr_name: cutout