From 9088206eda1fecdfe2d643c9acb68a20c97460e0 Mon Sep 17 00:00:00 2001 From: Sean Date: Fri, 29 Nov 2024 21:43:56 +0800 Subject: [PATCH] fix[documentation]: Update links to point to correct pages (#549) # What does this PR do? In short, provide a summary of what this PR does and why. Usually, the relevant context should be present in a linked issue. - [x] Addresses issue (#548) ## Test Plan Please describe: No automated tests. Clicked on each link to ensure I was directed to the right page. ## Sources ## Before submitting - [x] This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case). - [x] Ran pre-commit to handle lint / formatting issues. - [x] Read the [contributor guideline](https://github.com/meta-llama/llama-stack/blob/main/CONTRIBUTING.md), Pull Request section? - [x] Updated relevant documentation. - [ ] ~Wrote necessary unit or integration tests.~ --- .../01_Local_Cloud_Inference101.ipynb | 2 +- .../02_Prompt_Engineering101.ipynb | 2 +- docs/zero_to_hero_guide/03_Image_Chat101.ipynb | 2 +- docs/zero_to_hero_guide/05_Memory101.ipynb | 2 +- docs/zero_to_hero_guide/06_Safety101.ipynb | 2 +- docs/zero_to_hero_guide/README.md | 14 +++++++------- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/zero_to_hero_guide/01_Local_Cloud_Inference101.ipynb b/docs/zero_to_hero_guide/01_Local_Cloud_Inference101.ipynb index 7225f0741..bdfd3520f 100644 --- a/docs/zero_to_hero_guide/01_Local_Cloud_Inference101.ipynb +++ b/docs/zero_to_hero_guide/01_Local_Cloud_Inference101.ipynb @@ -231,7 +231,7 @@ "source": [ "Thanks for checking out this notebook! \n", "\n", - "The next one will be a guide on [Prompt Engineering](./01_Prompt_Engineering101.ipynb), please continue learning!" + "The next one will be a guide on [Prompt Engineering](./02_Prompt_Engineering101.ipynb), please continue learning!" ] } ], diff --git a/docs/zero_to_hero_guide/02_Prompt_Engineering101.ipynb b/docs/zero_to_hero_guide/02_Prompt_Engineering101.ipynb index c66192d81..c1c8a5aa9 100644 --- a/docs/zero_to_hero_guide/02_Prompt_Engineering101.ipynb +++ b/docs/zero_to_hero_guide/02_Prompt_Engineering101.ipynb @@ -276,7 +276,7 @@ "source": [ "Thanks for checking out this notebook! \n", "\n", - "The next one will be a guide on how to chat with images, continue to the notebook [here](./02_Image_Chat101.ipynb). Happy learning!" + "The next one will be a guide on how to chat with images, continue to the notebook [here](./03_Image_Chat101.ipynb). Happy learning!" ] } ], diff --git a/docs/zero_to_hero_guide/03_Image_Chat101.ipynb b/docs/zero_to_hero_guide/03_Image_Chat101.ipynb index 93042f3fc..02c32191f 100644 --- a/docs/zero_to_hero_guide/03_Image_Chat101.ipynb +++ b/docs/zero_to_hero_guide/03_Image_Chat101.ipynb @@ -175,7 +175,7 @@ "source": [ "Thanks for checking out this notebook! \n", "\n", - "The next one in the series will teach you one of the favorite applications of Large Language Models: [Tool Calling](./03_Tool_Calling101.ipynb). Enjoy!" + "The next one in the series will teach you one of the favorite applications of Large Language Models: [Tool Calling](./04_Tool_Calling101.ipynb). Enjoy!" ] } ], diff --git a/docs/zero_to_hero_guide/05_Memory101.ipynb b/docs/zero_to_hero_guide/05_Memory101.ipynb index e7e64d8fa..21678fd55 100644 --- a/docs/zero_to_hero_guide/05_Memory101.ipynb +++ b/docs/zero_to_hero_guide/05_Memory101.ipynb @@ -373,7 +373,7 @@ "source": [ "Awesome, now we can embed all our notes with Llama-stack and ask it about the meaning of life :)\n", "\n", - "Next up, we will learn about the safety features and how to use them: [notebook link](./05_Safety101.ipynb)" + "Next up, we will learn about the safety features and how to use them: [notebook link](./06_Safety101.ipynb)." ] } ], diff --git a/docs/zero_to_hero_guide/06_Safety101.ipynb b/docs/zero_to_hero_guide/06_Safety101.ipynb index bf37e83ea..6b5bd53bf 100644 --- a/docs/zero_to_hero_guide/06_Safety101.ipynb +++ b/docs/zero_to_hero_guide/06_Safety101.ipynb @@ -107,7 +107,7 @@ "source": [ "Thanks for leaning about the Safety API of Llama-Stack. \n", "\n", - "Finally, we learn about the Agents API, [here](./06_Agents101.ipynb)" + "Finally, we learn about the Agents API, [here](./07_Agents101.ipynb)." ] } ], diff --git a/docs/zero_to_hero_guide/README.md b/docs/zero_to_hero_guide/README.md index 449e40430..9b373fd9a 100644 --- a/docs/zero_to_hero_guide/README.md +++ b/docs/zero_to_hero_guide/README.md @@ -229,13 +229,13 @@ This command initializes the model to interact with your local Llama Stack insta **Explore Other Guides**: Dive deeper into specific topics by following these guides: - [Understanding Distribution](https://llama-stack.readthedocs.io/en/latest/getting_started/index.html#decide-your-inference-provider) - [Inference 101](00_Inference101.ipynb) -- [Local and Cloud Model Toggling 101](00_Local_Cloud_Inference101.ipynb) -- [Prompt Engineering](01_Prompt_Engineering101.ipynb) -- [Chat with Image - LlamaStack Vision API](02_Image_Chat101.ipynb) -- [Tool Calling: How to and Details](03_Tool_Calling101.ipynb) -- [Memory API: Show Simple In-Memory Retrieval](04_Memory101.ipynb) -- [Using Safety API in Conversation](05_Safety101.ipynb) -- [Agents API: Explain Components](06_Agents101.ipynb) +- [Local and Cloud Model Toggling 101](01_Local_Cloud_Inference101.ipynb) +- [Prompt Engineering](02_Prompt_Engineering101.ipynb) +- [Chat with Image - LlamaStack Vision API](03_Image_Chat101.ipynb) +- [Tool Calling: How to and Details](04_Tool_Calling101.ipynb) +- [Memory API: Show Simple In-Memory Retrieval](05_Memory101.ipynb) +- [Using Safety API in Conversation](06_Safety101.ipynb) +- [Agents API: Explain Components](07_Agents101.ipynb) **Explore Client SDKs**: Utilize our client SDKs for various languages to integrate Llama Stack into your applications: