llama-stack-mirror/docs/zero_to_hero_guide

Llama Stack: from Zero to Hero

Llama Stack defines and standardizes the set of core building blocks needed to bring generative AI applications to market. These building blocks are presented in the form of interoperable APIs with a broad set of Providers providing their implementations. These building blocks are assembled into Distributions which are easy for developers to get from zero to production.

This guide will walk you through an end-to-end workflow with Llama Stack with Ollama as the inference provider and ChromaDB as the VectorIO provider. Please note the steps for configuring your provider and distribution will vary depending on the services you use. However, the user experience will remain universal - this is the power of Llama-Stack.

If you're looking for more specific topics, we have a Zero to Hero Guide that covers everything from 'Tool Calling' to 'Agents' in detail. Feel free to skip to the end to explore the advanced topics you're interested in.

If you'd prefer not to set up a local server, explore our notebook on tool calling with the Together API. This notebook will show you how to leverage together.ai's Llama Stack Server API, allowing you to get started with Llama Stack without the need for a locally built and running server.

Table of Contents

1. Setup and run ollama
2. Install Dependencies and Set Up Environment
3. Build, Configure, and Run Llama Stack
4. Test with llama-stack-client CLI
5. Test with curl
6. Test with Python
7. Next Steps

---

Setup ollama

1. Download Ollama App:

   • Go to https://ollama.com/download.
   • Follow instructions based on the OS you are on. For example, if you are on a Mac, download and unzip Ollama-darwin.zip.
   • Run the Ollama application.

2. Download the Ollama CLI: Ensure you have the ollama command line tool by downloading and installing it from the same website.

3. Start ollama server: Open the terminal and run:

   ollama serve
   

4. Run the model: Open the terminal and run:

   ollama run llama3.2:3b-instruct-fp16 --keepalive -1m
   

   Note:

   • The supported models for llama stack for now is listed in here
   • keepalive -1m is used so that ollama continues to keep the model in memory indefinitely. Otherwise, ollama frees up memory and you would have to run ollama run again.

---

Install Dependencies and Set Up Environment

1. Create a Conda Environment: Create a new Conda environment with Python 3.12:

   conda create -n ollama python=3.12
   

   Activate the environment:

   conda activate ollama
   

2. Install ChromaDB: Install chromadb using pip:

   pip install chromadb
   

3. Run ChromaDB: Start the ChromaDB server:

   chroma run --host localhost --port 8000 --path ./my_chroma_data
   

4. Install Llama Stack: Open a new terminal and install llama-stack:

   conda activate ollama
   pip install -U llama-stack
   

---

Build, Configure, and Run Llama Stack

1. Build the Llama Stack: Build the Llama Stack using the ollama template:

   llama stack build --template ollama --image-type conda
   

   Expected Output:

   ...
   Build Successful!
   You can find the newly-built template here: ~/.llama/distributions/ollama/ollama-run.yaml
   You can run the new Llama Stack Distro via: llama stack run ~/.llama/distributions/ollama/ollama-run.yaml --image-type conda
   

2. Set the ENV variables by exporting them to the terminal:

   export OLLAMA_URL="http://localhost:11434"
   export LLAMA_STACK_PORT=8321
   export INFERENCE_MODEL="meta-llama/Llama-3.2-3B-Instruct"
   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:

   llama stack run ollama
      --port $LLAMA_STACK_PORT
      --env INFERENCE_MODEL=$INFERENCE_MODEL
      --env SAFETY_MODEL=$SAFETY_MODEL
      --env OLLAMA_URL=$OLLAMA_URL
   

   Note: Every time you run a new model with ollama run, you will need to restart the llama stack. Otherwise it won't see the new model.

The server will start and listen on http://localhost:8321.

---

Test with llama-stack-client CLI

After setting up the server, open a new terminal window and configure the llama-stack-client.

1. Configure the CLI to point to the llama-stack server.

   llama-stack-client configure --endpoint http://localhost:8321
   

   Expected Output:

   Done! You can now use the Llama Stack Client CLI with endpoint http://localhost:8321
   

2. Test the CLI by running inference:

   llama-stack-client inference chat-completion --message "Write me a 2-sentence poem about the moon"
   

   Expected Output:

   ChatCompletionResponse(
       completion_message=CompletionMessage(
           content='Here is a 2-sentence poem about the moon:\n\nSilver crescent shining bright in the night,\nA beacon of wonder, full of gentle light.',
           role='assistant',
           stop_reason='end_of_turn',
           tool_calls=[]
       ),
       logprobs=None
   )
   

Test with curl

After setting up the server, open a new terminal window and verify it's working by sending a POST request using curl:

curl http://localhost:$LLAMA_STACK_PORT/alpha/inference/chat-completion
-H "Content-Type: application/json"
-d @- <<EOF
{
    "model_id": "$INFERENCE_MODEL",
    "messages": [
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Write me a 2-sentence poem about the moon"}
    ],
    "sampling_params": {
      "strategy": {
         "type": "top_p",
         "temperatrue": 0.7,
         "top_p": 0.95,
      },
      "seed": 42,
      "max_tokens": 512
   }
}
EOF

You can check the available models with the command llama-stack-client models list.

Expected Output:

{
  "completion_message": {
    "role": "assistant",
    "content": "The moon glows softly in the midnight sky,\nA beacon of wonder, as it catches the eye.",
    "stop_reason": "out_of_tokens",
    "tool_calls": []
  },
  "logprobs": null
}

---

Test with Python

You can also interact with the Llama Stack server using a simple Python script. Below is an example:

1. Activate Conda Environment

conda activate ollama

2. Create Python Script (test_llama_stack.py)

touch test_llama_stack.py

3. Create a Chat Completion Request in Python

In test_llama_stack.py, write the following code:

import os
from llama_stack_client import LlamaStackClient

# Get the model ID from the environment variable
INFERENCE_MODEL = os.environ.get("INFERENCE_MODEL")

# Check if the environment variable is se
if INFERENCE_MODEL is None:
    raise ValueError("The environment variable 'INFERENCE_MODEL' is not set.")

# Initialize the clien
client = LlamaStackClient(base_url="http://localhost:8321")

# Create a chat completion reques
response = client.inference.chat_completion(
    messages=[
        {"role": "system", "content": "You are a friendly assistant."},
        {"role": "user", "content": "Write a two-sentence poem about llama."},
    ],
    model_id=INFERENCE_MODEL,
)

# Print the response
print(response.completion_message.content)

4. Run the Python Script

python test_llama_stack.py

Expected Output:

The moon glows softly in the midnight sky,
A beacon of wonder, as it catches the eye.

With these steps, you should have a functional Llama Stack setup capable of generating text using the specified model. For more detailed information and advanced configurations, refer to some of our documentation below.

This command initializes the model to interact with your local Llama Stack instance.

---

Next Steps

Explore Other Guides: Dive deeper into specific topics by following these guides:

• Understanding Distribution
• Inference 101
• Local and Cloud Model Toggling 101
• Prompt Engineering
• Chat with Image - LlamaStack Vision API
• Tool Calling: How to and Details
• Memory API: Show Simple In-Memory Retrieval
• Using Safety API in Conversation
• Agents API: Explain Components

Explore Client SDKs: Utilize our client SDKs for various languages to integrate Llama Stack into your applications:

• Python SDK
• Node SDK
• Swift SDK
• Kotlin SDK

Advanced Configuration: Learn how to customize your Llama Stack distribution by referring to the Building a Llama Stack Distribution guide.

Explore Example Apps: Check out llama-stack-apps for example applications built using Llama Stack.

---