phoenix-oss/llama-stack-mirror
0
0
Fork 1
mirror of https://github.com/meta-llama/llama-stack.git synced 2025-08-03 01:03:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

address comments

Browse source
This commit is contained in:
Xi Yan 2024-12-12 10:38:29 -08:00
parent 69306858e4
commit 75066663f1
2 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/source/index.md
View file

@ -58,7 +58,7 @@ getting_started/index
concepts/index concepts/index
distributions/index distributions/index
building_applications/index building_applications/index
ui/index playground/index
contributing/index contributing/index
references/index references/index
cookbooks/index cookbooks/index

16
docs/source/ui/index.md → docs/source/playground/index.md
View file

@ -1,13 +1,13 @@
# Playground UI # Llama Stack Playground
```{note} ```{note}
Playground UI is currently experimental and subject to change. We welcome feedback and contributions to help improve it. The Llama Stack Playground is currently experimental and subject to change. We welcome feedback and contributions to help improve it.
``` ```
Llama Stack Playground UI is an simple interface aims to: The Llama Stack Playground is an simple interface which aims to:
- Showcase **capabilities** and **concepts** of Llama Stack in an interactive environment - Showcase **capabilities** and **concepts** of Llama Stack in an interactive environment
- Demo **end-to-end** application code to help users get started to build their own applications - Demo **end-to-end** application code to help users get started to build their own applications
- Provide an **UI** to help users inspect and analyze Llama Stack API providers and resources - Provide an **UI** to help users inspect and understand Llama Stack API providers and resources
## Key Features ## Key Features
@ -24,7 +24,7 @@ Interactive pages for users to play with and explore Llama Stack API capabilitie
:width: 100% :width: 100%
``` ```
- **Chat**: Chat with Llama models. - **Chat**: Chat with Llama models.
- This page is a simple chatbot that allows you to chat with Llama models. Under the hood, it uses the `/inference/chat_completion` streaming API to send messages to the model and receive responses. - This page is a simple chatbot that allows you to chat with Llama models. Under the hood, it uses the `/inference/chat-completion` streaming API to send messages to the model and receive responses.
- **RAG**: Uploading documents to memory_banks and chat with RAG agent - **RAG**: Uploading documents to memory_banks and chat with RAG agent
- This page allows you to upload documents as a `memory_bank` and then chat with a RAG agent to query information about the uploaded documents. - This page allows you to upload documents as a `memory_bank` and then chat with a RAG agent to query information about the uploaded documents.
- Under the hood, it uses Llama Stack's `/agents` API to define and create a RAG agent and chat with it in a session. - Under the hood, it uses Llama Stack's `/agents` API to define and create a RAG agent and chat with it in a session.
@ -60,7 +60,7 @@ Interactive pages for users to play with and explore Llama Stack API capabilitie
--provider-id "huggingface" \ --provider-id "huggingface" \
--url "https://huggingface.co/datasets/llamastack/evals" \ --url "https://huggingface.co/datasets/llamastack/evals" \
--metadata '{"path": "llamastack/evals", "name": "evals__mmlu__details", "split": "train"}' \ --metadata '{"path": "llamastack/evals", "name": "evals__mmlu__details", "split": "train"}' \
--schema '{"input_query": {"type": "string"}, "expected_answer": {"type": "string", "chat_completion_input": {"type": "string"}}}' --schema '{"input_query": {"type": "string"}, "expected_answer": {"type": "string"}, "chat_completion_input": {"type": "string"}}'
``` ```
```bash ```bash
@ -90,9 +90,9 @@ Interactive pages for users to play with and explore Llama Stack API capabilitie
- Under the hood, it uses Llama Stack's `/<resources>/list` API to get information about each resources. - Under the hood, it uses Llama Stack's `/<resources>/list` API to get information about each resources.
- Please visit [Core Concepts](https://llama-stack.readthedocs.io/en/latest/concepts/index.html) for more details about the resources. - Please visit [Core Concepts](https://llama-stack.readthedocs.io/en/latest/concepts/index.html) for more details about the resources.
## Starting the Playground UI ## Starting the Llama Stack Playground
To start the Playground UI, run the following commands: To start the Llama Stack Playground, run the following commands:
1. Start up the Llama Stack API server 1. Start up the Llama Stack API server