From 4ee1fec26ddc7774d6fa9f85ec9f72192fee634c Mon Sep 17 00:00:00 2001
From: Frank Guibert <frank.guibert@meteo.fr>
Date: Thu, 4 Jul 2024 10:32:14 +0000
Subject: [PATCH] adds HalfUnet to illustrate the doc

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index 273f5fc..63f5814 100644
--- a/README.md
+++ b/README.md
@@ -31,6 +31,16 @@ Each model we provide is a subclass of [torch.nn.Module](https://pytorch.org/doc
 - **onnx_supported**: a boolean that indicates if the model can be exported to onnx. Our CI validates that the model can be exported to onnx and reloaded for inference.
 
 ```python
+@dataclass_json
+@dataclass(slots=True)
+class HalfUNetSettings:
+    num_filters: int = 64
+    dilation: int = 1
+    bias: bool = False
+    use_ghost: bool = False
+    last_activation: str = "Identity"
+    absolute_pos_embed: bool = False
+
 class HalfUNet(nn.Module):
     settings_kls = HalfUNetSettings
     onnx_supported = True