From 97d4ff4227ce2b01ddaedb6b9c223ff9fbba69a3 Mon Sep 17 00:00:00 2001 From: Justin Lee Date: Fri, 22 Nov 2024 09:06:57 -0800 Subject: [PATCH] changes from PR review --- README.md | 3 ++- {zero_to_hero_guide => docs/zero_to_hero_guide}/.env.template | 0 .../zero_to_hero_guide}/00_Inference101.ipynb | 0 .../zero_to_hero_guide}/01_Local_Cloud_Inference101.ipynb | 0 .../zero_to_hero_guide}/02_Prompt_Engineering101.ipynb | 0 .../zero_to_hero_guide}/03_Image_Chat101.ipynb | 0 .../zero_to_hero_guide}/04_Tool_Calling101.ipynb | 0 .../zero_to_hero_guide}/05_Memory101.ipynb | 0 .../zero_to_hero_guide}/06_Safety101.ipynb | 0 .../zero_to_hero_guide}/07_Agents101.ipynb | 0 .../Tool_Calling101_Using_Together's_Llama_Stack_Server.ipynb | 0 {zero_to_hero_guide => docs/zero_to_hero_guide}/quickstart.md | 2 +- 12 files changed, 3 insertions(+), 2 deletions(-) rename {zero_to_hero_guide => docs/zero_to_hero_guide}/.env.template (100%) rename {zero_to_hero_guide => docs/zero_to_hero_guide}/00_Inference101.ipynb (100%) rename {zero_to_hero_guide => docs/zero_to_hero_guide}/01_Local_Cloud_Inference101.ipynb (100%) rename {zero_to_hero_guide => docs/zero_to_hero_guide}/02_Prompt_Engineering101.ipynb (100%) rename {zero_to_hero_guide => docs/zero_to_hero_guide}/03_Image_Chat101.ipynb (100%) rename {zero_to_hero_guide => docs/zero_to_hero_guide}/04_Tool_Calling101.ipynb (100%) rename {zero_to_hero_guide => docs/zero_to_hero_guide}/05_Memory101.ipynb (100%) rename {zero_to_hero_guide => docs/zero_to_hero_guide}/06_Safety101.ipynb (100%) rename {zero_to_hero_guide => docs/zero_to_hero_guide}/07_Agents101.ipynb (100%) rename {zero_to_hero_guide => docs/zero_to_hero_guide}/Tool_Calling101_Using_Together's_Llama_Stack_Server.ipynb (100%) rename {zero_to_hero_guide => docs/zero_to_hero_guide}/quickstart.md (98%) diff --git a/README.md b/README.md index 0f5776eb8..f04213273 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![PyPI - Downloads](https://img.shields.io/pypi/dm/llama-stack)](https://pypi.org/project/llama-stack/) [![Discord](https://img.shields.io/discord/1257833999603335178)](https://discord.gg/llama-stack) -[**Quick Start**](https://llama-stack.readthedocs.io/en/latest/getting_started/index.html) | [**Documentation**](https://llama-stack.readthedocs.io/en/latest/index.html) +[**Quick Start**](https://llama-stack.readthedocs.io/en/latest/getting_started/index.html) | [**Documentation**](https://llama-stack.readthedocs.io/en/latest/index.html) | [**Zero2Hero Guide**](https://github.com/meta-llama/llama-stack/tree/main/docs/zero_to_hero_guide) This repository contains the Llama Stack API specifications as well as API Providers and Llama Stack Distributions. @@ -103,6 +103,7 @@ Please checkout our [Documentations](https://llama-stack.readthedocs.io/en/lates * Quick guide to start a Llama Stack server. * [Jupyter notebook](./docs/getting_started.ipynb) to walk-through how to use simple text and vision inference llama_stack_client APIs * The complete Llama Stack lesson [Colab notebook](https://colab.research.google.com/drive/1dtVmxotBsI4cGZQNsJRYPrLiDeT0Wnwt) of the new [Llama 3.2 course on Deeplearning.ai](https://learn.deeplearning.ai/courses/introducing-multimodal-llama-3-2/lesson/8/llama-stack). + * The [Zero2Hero Guide](https://github.com/meta-llama/llama-stack/tree/main/docs/zero_to_hero_guide) that guide you through all the key components of llama stack with code samples. * [Contributing](CONTRIBUTING.md) * [Adding a new API Provider](https://llama-stack.readthedocs.io/en/latest/api_providers/new_api_provider.html) to walk-through how to add a new API provider. diff --git a/zero_to_hero_guide/.env.template b/docs/zero_to_hero_guide/.env.template similarity index 100% rename from zero_to_hero_guide/.env.template rename to docs/zero_to_hero_guide/.env.template diff --git a/zero_to_hero_guide/00_Inference101.ipynb b/docs/zero_to_hero_guide/00_Inference101.ipynb similarity index 100% rename from zero_to_hero_guide/00_Inference101.ipynb rename to docs/zero_to_hero_guide/00_Inference101.ipynb diff --git a/zero_to_hero_guide/01_Local_Cloud_Inference101.ipynb b/docs/zero_to_hero_guide/01_Local_Cloud_Inference101.ipynb similarity index 100% rename from zero_to_hero_guide/01_Local_Cloud_Inference101.ipynb rename to docs/zero_to_hero_guide/01_Local_Cloud_Inference101.ipynb diff --git a/zero_to_hero_guide/02_Prompt_Engineering101.ipynb b/docs/zero_to_hero_guide/02_Prompt_Engineering101.ipynb similarity index 100% rename from zero_to_hero_guide/02_Prompt_Engineering101.ipynb rename to docs/zero_to_hero_guide/02_Prompt_Engineering101.ipynb diff --git a/zero_to_hero_guide/03_Image_Chat101.ipynb b/docs/zero_to_hero_guide/03_Image_Chat101.ipynb similarity index 100% rename from zero_to_hero_guide/03_Image_Chat101.ipynb rename to docs/zero_to_hero_guide/03_Image_Chat101.ipynb diff --git a/zero_to_hero_guide/04_Tool_Calling101.ipynb b/docs/zero_to_hero_guide/04_Tool_Calling101.ipynb similarity index 100% rename from zero_to_hero_guide/04_Tool_Calling101.ipynb rename to docs/zero_to_hero_guide/04_Tool_Calling101.ipynb diff --git a/zero_to_hero_guide/05_Memory101.ipynb b/docs/zero_to_hero_guide/05_Memory101.ipynb similarity index 100% rename from zero_to_hero_guide/05_Memory101.ipynb rename to docs/zero_to_hero_guide/05_Memory101.ipynb diff --git a/zero_to_hero_guide/06_Safety101.ipynb b/docs/zero_to_hero_guide/06_Safety101.ipynb similarity index 100% rename from zero_to_hero_guide/06_Safety101.ipynb rename to docs/zero_to_hero_guide/06_Safety101.ipynb diff --git a/zero_to_hero_guide/07_Agents101.ipynb b/docs/zero_to_hero_guide/07_Agents101.ipynb similarity index 100% rename from zero_to_hero_guide/07_Agents101.ipynb rename to docs/zero_to_hero_guide/07_Agents101.ipynb diff --git a/zero_to_hero_guide/Tool_Calling101_Using_Together's_Llama_Stack_Server.ipynb b/docs/zero_to_hero_guide/Tool_Calling101_Using_Together's_Llama_Stack_Server.ipynb similarity index 100% rename from zero_to_hero_guide/Tool_Calling101_Using_Together's_Llama_Stack_Server.ipynb rename to docs/zero_to_hero_guide/Tool_Calling101_Using_Together's_Llama_Stack_Server.ipynb diff --git a/zero_to_hero_guide/quickstart.md b/docs/zero_to_hero_guide/quickstart.md similarity index 98% rename from zero_to_hero_guide/quickstart.md rename to docs/zero_to_hero_guide/quickstart.md index 28c77bfd4..704db8454 100644 --- a/zero_to_hero_guide/quickstart.md +++ b/docs/zero_to_hero_guide/quickstart.md @@ -121,7 +121,7 @@ export SAFETY_MODEL="meta-llama/Llama-Guard-3-1B" 3. **Run the Llama Stack**: - Run the stack with command shared by the API from earlier: ```bash - llama stack run /Users/username/.llama/distributions/llamastack-ollama/ollama-run.yaml \ + llama stack run ollama \ --port $LLAMA_STACK_PORT \ --env INFERENCE_MODEL=$INFERENCE_MODEL \ --env SAFETY_MODEL=$SAFETY_MODEL \