Docs for example 5

Cambridge-ICCS · Jul 23, 2024 · b8b4840 · b8b4840
1 parent cf9a006
commit b8b4840
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/examples/5_Autograd/README.md b/examples/5_Autograd/README.md
@@ -1,7 +1,7 @@
 # Example 5 - Autograd
 
-This example will demonstrate automatic differentation in FTorch by leveraging
-PyTorch's Autograd module.
+**This example is currently under development.** Eventually, it will demonstrate
+automatic differentation in FTorch by leveraging PyTorch's Autograd module.
 
 By exposing Autograd in Fortran, FTorch will be able to compute derivatives of
 expressions involving `torch_tensor`s.

diff --git a/pages/examples.md b/pages/examples.md
@@ -186,3 +186,10 @@ data to multiple GPU devices.
 [This worked example](https://github.com/Cambridge-ICCS/FTorch/tree/main/examples/4_MultiIO)
 considers a variant of the SimpleNet demo, which demonstrates how to account for
 multiple input tensors and multiple output tensors.
+
+#### 5) Autograd
+
+[This worked example](https://github.com/Cambridge-ICCS/FTorch/tree/main/examples/5_Autograd)
+is currently under development. Eventually, it will demonstrate how to perform
+automatic differentiation in FTorch by leveraging PyTorch's Autograd module.
+Currently, it just demonstrates how to use `torch_tensor_to_array`.