Skip to content

Commit

Permalink
Merge pull request #268 from vrothberg/update-readmes
Browse files Browse the repository at this point in the history
chatbot/rag/summarizer: sync READMEs
  • Loading branch information
rhatdan authored Apr 15, 2024
2 parents 333fe7f + 90c4865 commit dc33008
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 19 deletions.
2 changes: 1 addition & 1 deletion recipes/natural_language_processing/chatbot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

There are a few options today for local Model Serving, but this recipe will use [`llama-cpp-python`](https://github.com/abetlen/llama-cpp-python) and their OpenAI compatible Model Service. There is a Containerfile provided that can be used to build this Model Service within the repo, [`model_servers/llamacpp_python/base/Containerfile`](/model_servers/llamacpp_python/base/Containerfile).

The AI Application will connect to the Model Service via it's OpenAI compatible API. The recipe relies on [Langchain's](https://python.langchain.com/docs/get_started/introduction) python package to simplify communication with the Model Service and uses [Streamlit](https://streamlit.io/) for the UI layer. You can find an example of the chat application below.
The AI Application will connect to the Model Service via its OpenAI compatible API. The recipe relies on [Langchain's](https://python.langchain.com/docs/get_started/introduction) python package to simplify communication with the Model Service and uses [Streamlit](https://streamlit.io/) for the UI layer. You can find an example of the chat application below.

![](/assets/chatbot_ui.png)

Expand Down
16 changes: 7 additions & 9 deletions recipes/natural_language_processing/rag/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,32 +14,30 @@ Our AI Application will connect to our Model Service via it's OpenAI compatible
## Try the RAG chat application

_COMING SOON to AI LAB_
Podman desktop [AI Lab extension](https://github.com/containers/podman-desktop-extension-ai-lab) will include this application as a sample recipe.
Choose `Recipes Catalog` -> `RAG Chatbot` to launch from the AI Lab extension in podman desktop when it's available.
The [Podman Desktop](https://podman-desktop.io) [AI Lab Extension](https://github.com/containers/podman-desktop-extension-ai-lab) includes this recipe among others. To try it out, open `Recipes Catalog` -> `RAG Chatbot` and follow the instructions to start the application.

There are also published images to try out this application as a local pod without the need to build anything yourself.
Start a local pod by running the following from this directory:
If you prefer building and running the application from terminal, please run the following commands from this directory.

First, build application's meta data and run the generated Kubernetes YAML which will spin up a Pod along with a number of containers:
```
make quadlet
podman kube play build/rag.yaml
```

To monitor this application running as a local pod, run:

The Pod is named `rag`, so you may use [Podman](https://podman.io) to manage the Pod and its containers:
```
podman pod list
podman ps
```

And, to stop the application:

To stop and remove the Pod, run:
```
podman pod stop rag
podman pod rm rag
```

After the pod is running, refer to the section below to [interact with the RAG chat application](#interact-with-the-ai-application).
Once the Pod is running, please refer to the section below to [interact with the RAG chatbot application](#interact-with-the-ai-application).

# Build the Application

In order to build this application we will need two models, a Vector Database, a Model Service and an AI Application.
Expand Down
15 changes: 6 additions & 9 deletions recipes/natural_language_processing/summarizer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,32 +14,29 @@ This example is designed to ingest an arbitrarily long text file as input. If th

## Try the summarizer application

Podman desktop [AI Lab extension](https://github.com/containers/podman-desktop-extension-ai-lab) includes this application as a sample recipe.
Choose `Recipes Catalog` -> `Summarizer` to launch from the AI Lab extension in podman desktop.
The [Podman Desktop](https://podman-desktop.io) [AI Lab Extension](https://github.com/containers/podman-desktop-extension-ai-lab) includes this recipe among others. To try it out, open `Recipes Catalog` -> `Summarizer` and follow the instructions to start the application.

There are also published images to try out this application as a local pod without the need to build anything yourself.
Start a local pod by running the following from this directory:
If you prefer building and running the application from terminal, please run the following commands from this directory.

First, build application's meta data and run the generated Kubernetes YAML which will spin up a Pod along with a number of containers:
```
make quadlet
podman kube play build/summarizer.yaml
```

To monitor this application running as a local pod, run:

The Pod is named `summarizer`, so you may use [Podman](https://podman.io) to manage the Pod and its containers:
```
podman pod list
podman ps
```

And, to stop the application:

To stop and remove the Pod, run:
```
podman pod stop summarizer
podman pod rm summarizer
```

After the pod is running, refer to the section below to [interact with the summarizer application](#interact-with-the-ai-application).
Once the Pod is running, please refer to the section below to [interact with the summarizer application](#interact-with-the-ai-application).

# Build the Application

Expand Down

0 comments on commit dc33008

Please sign in to comment.