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

more details

Browse source
This commit is contained in:
Xi Yan 2024-12-09 18:22:31 -08:00
parent 82a325517a
commit 69306858e4
1 changed files with 33 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

73
docs/source/ui/index.md
View file

@ -23,8 +23,11 @@ Interactive pages for users to play with and explore Llama Stack API capabilitie
:loop: :loop:
: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.
- **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.
- Under the hood, it uses Llama Stack's `/agents` API to define and create a RAG agent and chat with it in a session.
##### Evaluations ##### Evaluations
```{eval-rst} ```{eval-rst}
@ -35,8 +38,9 @@ Interactive pages for users to play with and explore Llama Stack API capabilitie
:loop: :loop:
:width: 100% :width: 100%
``` ```
- **Evaluations (Scoring)**: Run evaluations on your AI application datasets - **Evaluations (Scoring)**: Run evaluations on your AI application datasets.
- This page demonstrates the flow evaluation API to run evaluations on your custom AI application datasets. You may upload your own evaluation datasets and run evaluations using available scoring functions.
- Under the hood, it uses Llama Stack's `/scoring` API to run evaluations on selected scoring functions.
```{eval-rst} ```{eval-rst}
.. video:: https://github.com/user-attachments/assets/345845c7-2a2b-4095-960a-9ae40f6a93cf .. video:: https://github.com/user-attachments/assets/345845c7-2a2b-4095-960a-9ae40f6a93cf
@ -47,34 +51,9 @@ Interactive pages for users to play with and explore Llama Stack API capabilitie
:width: 100% :width: 100%
``` ```
- **Evaluations (Generation + Scoring)**: Use pre-registered evaluation tasks to evaluate an model or agent candidate - **Evaluations (Generation + Scoring)**: Use pre-registered evaluation tasks to evaluate an model or agent candidate
- This page demonstrates the flow for evaluation API to evaluate an model or agent candidate on pre-defined evaluation tasks. An evaluation task is a combination of dataset and scoring functions.
- Under the hood, it uses Llama Stack's `/eval` API to run generations and scorings on specified evaluation configs.
- In order to run this page, you may need to register evaluation tasks and datasets as resources first through the following commands.
##### Inspect
```{eval-rst}
.. video:: https://github.com/user-attachments/assets/01d52b2d-92af-4e3a-b623-a9b8ba22ba99
:autoplay:
:playsinline:
:muted:
:loop:
:width: 100%
```
- **Inspect** Llama Stack API providers and resources (models, datasets, memory_banks, eval_tasks, etc).
## Starting the Playground UI
To start the Playground UI, run the following commands:
1. Start up the Llama Stack API server
```bash
llama stack build --template together --image-type conda
llama stack run together
```
2. (Optional) Register datasets and eval tasks as resources. If you want to run pre-configured evaluation flows (e.g. Evaluations (Generation + Scoring) Page).
```bash ```bash
$ llama-stack-client datasets register \ $ llama-stack-client datasets register \
--dataset-id "mmlu" \ --dataset-id "mmlu" \
@ -92,7 +71,37 @@ $ llama-stack-client eval_tasks register \
--scoring-functions basic::regex_parser_multiple_choice_answer --scoring-functions basic::regex_parser_multiple_choice_answer
``` ```
3. Start Streamlit UI
##### Inspect
```{eval-rst}
.. video:: https://github.com/user-attachments/assets/01d52b2d-92af-4e3a-b623-a9b8ba22ba99
:autoplay:
:playsinline:
:muted:
:loop:
:width: 100%
```
- **API Providers**: Inspect Llama Stack API providers
- This page allows you to inspect Llama Stack API providers and resources.
- Under the hood, it uses Llama Stack's `/providers` API to get information about the providers.
- **API Resources**: Inspect Llama Stack API resources
- This page allows you to inspect Llama Stack API resources (`models`, `datasets`, `memory_banks`, `eval_tasks`, `shields`).
- 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.
## Starting the Playground UI
To start the Playground UI, run the following commands:
1. Start up the Llama Stack API server
```bash
llama stack build --template together --image-type conda
llama stack run together
```
2. Start Streamlit UI
```bash ```bash
cd llama_stack/distribution/ui cd llama_stack/distribution/ui
pip install -r requirements.txt pip install -r requirements.txt