Skip to content

Commit 22f2831

Browse files
authored
docs: Fix broken links to examples, recipes, and setup guides in README and blog (#106)
1 parent 684fc1e commit 22f2831

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ We love Tinker. Tinker simplifies LLM post-training for developers and researche
1111
## Quick Start
1212

1313
- Follow the [Pig Latin notebook](examples/sft/pig-latin/piglatin_sft_notebook.ipynb) or [Text-to-SQL notebook](examples/sft/text-to-sql/texttosql_sft_notebook.ipynb) to see supervised fine-tuning in action.
14-
- Follow the [Text-to-SQL RL recipe](examples/rl/text-to-sql/README.md) to see reinforcement learning in action.
14+
- Follow the [Text-to-SQL RL recipe](examples/text-to-sql/README.md) to see reinforcement learning in action.
1515

1616
Snippet below shows a sample Reinforcement Learning loop like GRPO, where the 4 API primitives are used to create a generate-and-reward-train loop:
1717

@@ -78,15 +78,15 @@ Detailed guides and runnable examples are structured under `docs/` and `examples
7878

7979
- **Guides:**
8080
- Supervised finetuning:
81-
- [Pig Latin SFT Notebook](examples/sft/pig-latin/piglatin_sft_notebook.ipynb) & [script guide](docs/guides/supervised/pig-latin.md)
81+
- [Pig Latin SFT Notebook](examples/sft/pig-latin/piglatin_sft_notebook.ipynb) & [script guide](examples/sft/pig-latin/README.md)
8282
- [Text-to-SQL SFT Notebook](examples/sft/text-to-sql/texttosql_sft_notebook.ipynb)
8383
- Reinforcement Learning:
84-
- [Text-to-SQL RL Recipe](examples/rl/text-to-sql/README.md)
84+
- [Text-to-SQL RL Recipe](examples/text-to-sql/README.md)
8585
- **Technical Documentation**:
8686
- [Architecture](docs/architecture.md)
8787
- [Tinker Client Compatibility](docs/tinker-client-compatibility.md)
8888
- **Deployment**:
89-
- [Kubernetes Deployment Guide (GKE)](docs/deployment.md)
89+
- [Kubernetes Deployment Guide (GKE)](docs/setup/gke-setup.md)
9090

9191
## Roadmap
9292

docs/blog/from-mac-to-gke.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,9 @@ Check out the [Architecture Deep Dive](../architecture.md) for a detailed explan
101101

102102
## Get Started
103103

104-
- **[Text-to-SQL Notebook](../../client/texttosql_sft_notebook.ipynb)** — Fine-tune Gemma 3 1B locally, start to finish
105-
- **[Pig Latin Notebook](../../client/piglatin_sft_notebook.ipynb)** — Simpler example to learn the API
106-
- **[GKE Deployment Guide](../deployment.md)** — Set up the distributed backend on Kubernetes
104+
- **[Text-to-SQL Notebook](../../examples/sft/text-to-sql/texttosql_sft_notebook.ipynb)** — Fine-tune Gemma 3 1B locally, start to finish
105+
- **[Pig Latin Notebook](../../examples/sft/pig-latin/piglatin_sft_notebook.ipynb)** — Simpler example to learn the API
106+
- **[GKE Deployment Guide](../setup/gke-setup.md)** — Set up the distributed backend on Kubernetes
107107
- **[Architecture Deep Dive](../architecture.md)** — How the Gateway, Queue, and Clock Cycle Engine work together
108108

109109
OpenRL is Apache 2.0 licensed. Contributions welcome.

0 commit comments

Comments
 (0)