Update docs

thebuckleylab · Jun 20, 2024 · 00fa0bc · 00fa0bc
1 parent 1dded6e
commit 00fa0bc
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/docs/api/Gradients.md → docs/api/compute_pc_param_grads.md b/docs/api/Gradients.md → docs/api/compute_pc_param_grads.md
@@ -1,3 +1,3 @@
-# Gradients
+# compute_pc_param_grads
 
 ::: jpc.compute_pc_param_grads
diff --git a/docs/api/Energy functions.md → docs/api/pc_energy_fn.md b/docs/api/Energy functions.md → docs/api/pc_energy_fn.md
@@ -1,3 +1,3 @@
-# Energy functions
+# pc_energy_fn
 
 ::: jpc.pc_energy_fn
diff --git a/jpc/_test.py b/jpc/_test.py
@@ -1,4 +1,4 @@
-"""High-level functions to test predictive coding networks."""
+"""Utility functions to test predictive coding networks."""
 
 import equinox as eqx
 from jpc import (

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -104,9 +104,9 @@ nav:
           - 'api/get_fc_network.md'
     - Advanced API:
         - 'api/Initialisation.md'
-        - 'api/Energy functions.md'
+        - 'api/pc_energy_fn.md'
         - 'api/solve_pc_activities.md'
-        - 'api/Gradients.md'
+        - 'api/compute_pc_param_grads.md'
 
 copyright: |
   &copy; 2024 <a href="https://github.com/thebuckleylab"  target="_blank" rel="noopener">thebuckleylab</a>