docs: move examples and notebooks again

caretech-owl · Feb 4, 2025 · 62a7854 · 62a7854
1 parent acdac6a
commit 62a7854
Show file tree

Hide file tree

Showing 11 changed files with 19 additions and 11 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -16,9 +16,16 @@ If you just want to it try out, you can clone the project and install dependenci
 git clone https://github.com/caretech-owl/gerd.git
 cd gerd
 pip install -e ".[full]"
-python docs/examples/hello.py
+python examples/hello.py
 ```
 
+<details>
+<summary>Source: examples/hello.py</summary>
+```python
+--8<-- "examples/hello.py"
+```
+</details>
+
 If you want to try this out in your browser, head over to binder 👉 [![Binder](media/binder_badge.svg)](https://mybinder.org/v2/gh/caretech-owl/gerd/HEAD?labpath=%2Fnotebooks%2Fhello_gerd.ipynb). 
 Note that running LLMs on the CPU (and especially on limited virtual machines like binder) takes some time.
 
@@ -41,11 +48,10 @@ Click the 'Click to Upload' button and search for a [GRASCCO](https://pubmed.ncb
 ## Prompt Chaining
 
 Prompt chaining is a prompt engineering approach to increase the 'reflection' of a large language model onto its given answer.
-Check [examples/chaining.py](examples/chaining.py) for an illustration.
-
+Check `examples/chaining.py` for an illustration.
 
 ``` sh
-python docs/examples/chaining.py
+python examples/chaining.py
 # ...
 ====== Resolved prompt =====
 
@@ -57,14 +63,16 @@ Result: Based on the given information, the largest egg-laying mammal is the blu
 ```
 
 <details>
-
-<summary>config/gen_chaining.yml</summary>
-
-
+<summary>Source: examples/chaining.py</summary>
+```python
+--8<-- "examples/chaining.py"
+```
+</details>
+<details>
+<summary>Config: config/gen_chaining.yml</summary>
 ```yaml
 --8<-- "config/gen_chaining.yml"
 ```
-
 </details>
 
 

diff --git a/docs/develop.md b/docs/develop.md
@@ -124,8 +124,8 @@ uv run router[_dev]
 
 ### GitHub Actions
 
-GitHub Actions can be found under [.github/workflows](./.github/workflows/).
-There is currently one main CI workflow called `pythin-ci.yml`:
+GitHub Actions can be found under [.github/workflows](https://github.com/caretech-owl/gerd/tree/main/.github/workflows).
+There is currently one main CI workflow called `python-ci.yml`:
 
 ``` yaml
 --8<-- ".github/workflows/python-ci.yml"

diff --git a/docs/examples/chaining.py → examples/chaining.py b/docs/examples/chaining.py → examples/chaining.py
diff --git a/docs/examples/generate.py → examples/generate.py b/docs/examples/generate.py → examples/generate.py
diff --git a/docs/examples/grascco_instruct.py → examples/grascco_instruct.py b/docs/examples/grascco_instruct.py → examples/grascco_instruct.py
diff --git a/docs/examples/hello.py → examples/hello.py b/docs/examples/hello.py → examples/hello.py
diff --git a/docs/examples/run_lora_instruction.py → examples/run_lora_instruction.py b/docs/examples/run_lora_instruction.py → examples/run_lora_instruction.py
diff --git a/docs/examples/run_lora_unstructured.py → examples/run_lora_unstructured.py b/docs/examples/run_lora_unstructured.py → examples/run_lora_unstructured.py
diff --git a/docs/examples/train_lora_instruction.py → examples/train_lora_instruction.py b/docs/examples/train_lora_instruction.py → examples/train_lora_instruction.py
diff --git a/docs/examples/train_lora_unstructured.py → examples/train_lora_unstructured.py b/docs/examples/train_lora_unstructured.py → examples/train_lora_unstructured.py
diff --git a/docs/notebooks/hello_gerd.ipynb → notebooks/hello_gerd.ipynb b/docs/notebooks/hello_gerd.ipynb → notebooks/hello_gerd.ipynb