Fix / rename examples in docs

Signed-off-by: Fabrice Normandin <[email protected]>
mila-iqia · Nov 18, 2024 · 1e2d330 · 1e2d330
1 parent 2c6b126
commit 1e2d330
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 14 deletions.
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -7,11 +7,11 @@
     * [Thorough automated testing on SLURM clusters](features/testing.md)
     * features/*.md
   * [Examples 🧪](examples/index.md)
-    * [Image Classification (⚡)](examples/torch_sl_example.md)
-    * [Image Classification (jax+⚡)](examples/jax_sl_example.md)
+    * [Image Classification (⚡)](examples/image_classification.md)
+    * [Image Classification (jax+⚡)](examples/jax_image_classification.md)
     * [Text Classification (🤗+⚡)](examples/text_classification.md)
     * [Fine-tuning an LLM (🤗+⚡)](examples/llm_finetuning.md)
-    * [RL (jax)](examples/jax_rl_example.md)
+    * [Reinforcement Learning (jax)](examples/jax_rl.md)
     * [Running sweeps](examples/sweeps.md)
     * [Profiling your code📎](examples/profiling.md)
     * examples/*.md

diff --git a/docs/examples/torch_sl_example.md → docs/examples/image_classification.md b/docs/examples/torch_sl_example.md → docs/examples/image_classification.md
diff --git a/docs/examples/index.md b/docs/examples/index.md
@@ -12,10 +12,10 @@ additional_python_references:
 
 This template includes examples that use either Jax, PyTorch, or both!
 
-| Example link                                      | Research Area                              | Reference link         | Frameworks      |
-| ------------------------------------------------- | ------------------------------------------ | ---------------------- | --------------- |
-| [Image Classification](torch_sl_example.md)       | Supervised Learning (image classification) | `ImageClassifier`      | Torch + ⚡       |
-| [Image Classification (Jax)](jax_sl_example.md)   | Supervised Learning (image classification) | `JaxImageClassifier`   | Torch + Jax + ⚡ |
-| [Text Classification](text_classification.md)     | NLP (text classification)                  | `TextClassifier`       | Torch + 🤗 + ⚡   |
-| [Reinforcement Learning (Jax)](jax_rl_example.md) | RL                                         | `JaxRLExample`         | Jax             |
-| [LLM Fine-tuning](llm_finetuning.md)              | NLP (Causal language modeling)             | `LLMFineTuningExample` | Torch + 🤗 + ⚡   |
+| Example link                                              | Research Area                              | Reference link         | Frameworks      |
+| --------------------------------------------------------- | ------------------------------------------ | ---------------------- | --------------- |
+| [Image Classification](image_classification.md)           | Supervised Learning (image classification) | `ImageClassifier`      | Torch + ⚡       |
+| [Image Classification (Jax)](jax_image_classification.md) | Supervised Learning (image classification) | `JaxImageClassifier`   | Torch + Jax + ⚡ |
+| [Text Classification](text_classification.md)             | NLP (text classification)                  | `TextClassifier`       | Torch + 🤗 + ⚡   |
+| [Reinforcement Learning (Jax)](jax_rl.md)                 | RL                                         | `JaxRLExample`         | Jax             |
+| [LLM Fine-tuning](llm_finetuning.md)                      | NLP (Causal language modeling)             | `LLMFineTuningExample` | Torch + 🤗 + ⚡   |
diff --git a/docs/examples/jax_sl_example.md → docs/examples/jax_image_classification.md b/docs/examples/jax_sl_example.md → docs/examples/jax_image_classification.md
@@ -22,11 +22,11 @@ pass uses Jax to calculate the gradients, and the weights are updated by a PyTor
 
 !!! question "What about end-to-end training in Jax?"
 
-    See the [Jax RL Example](../examples/jax_rl_example.md)! :smile:
+    See the [Jax RL Example](../examples/jax_rl.md)! :smile:
 
 ### Jax Network
 
-{{ inline('project.algorithms.jax_image_classifier.CNN') }}
+{{ inline('project.algorithms.jax_image_classifier.JaxCNN') }}
 
 ### Jax Algorithm
 

diff --git a/docs/examples/jax_rl_example.md → docs/examples/jax_rl.md b/docs/examples/jax_rl_example.md → docs/examples/jax_rl.md
diff --git a/docs/features/jax.md b/docs/features/jax.md
@@ -32,12 +32,12 @@ training loop as usual, you can!
 
 The [lightning.Trainer][lightning.pytorch.trainer.trainer.Trainer] will not be able to tell that you're using Jax!
 
-**Take a look at [this image classification example that uses a Jax network](../examples/jax_sl_example.md).**
+**Take a look at [this image classification example that uses a Jax network](../examples/jax_image_classification.md).**
 
 
 ## End-to-end training in Jax: the `JaxTrainer`
 
-The `JaxTrainer`, used in the [Jax RL Example](../examples/jax_rl_example.md), follows a similar structure as the lightning Trainer. However, instead of training LightningModules, it trains `JaxModule`s, which are a simplified, jax-based look-alike of `lightning.LightningModule`s.
+The `JaxTrainer`, used in the [Jax RL Example](../examples/jax_rl.md), follows a similar structure as the lightning Trainer. However, instead of training LightningModules, it trains `JaxModule`s, which are a simplified, jax-based look-alike of `lightning.LightningModule`s.
 
 
 The "algorithm" needs to match the `JaxModule` protocol: