Skip to content

Commit

Permalink
Fix minor issues with LLM example documentation (nv-morpheus#1992)
Browse files Browse the repository at this point in the history
* Agents: Show an actual runnable command that can be copy/pasted, not just the command usage.
* Completion: Remove blank line in command block
* RAG: Remove section about fetching data, RAG doesn't need any LFS files.
* VDB Upload: Pipeline requires the `examples` dataset not the `datasets` dataset.
* VDB Upload: Document how to run Milvus

Closes nv-morpheus#1991

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/nv-morpheus/Morpheus/blob/main/docs/source/developer_guide/contributing.md).
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

Authors:
  - David Gardner (https://github.com/dagardner-nv)

Approvers:
  - Michael Demoret (https://github.com/mdemoret-nv)
  - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah)

URL: nv-morpheus#1992
  • Loading branch information
dagardner-nv authored Oct 25, 2024
1 parent be7e90f commit 13c7268
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 14 deletions.
5 changes: 4 additions & 1 deletion examples/llm/agents/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,10 +126,13 @@ This example demonstrates the basic implementation of Morpheus pipeline, showcas
- Stores and manages the results within the pipeline using an InMemorySinkStage.


To run the example with default options, use the following command:
```bash
python examples/llm/main.py agents simple [OPTIONS]
python examples/llm/main.py --log_level=info agents simple
```

Available options for the simple pipeline are as follows:

### Options:
- `--use_cpu_only`
- **Description**: Run in CPU only mode
Expand Down
1 change: 0 additions & 1 deletion examples/llm/completion/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,5 @@ python examples/llm/main.py completion [OPTIONS] COMMAND [ARGS]...
### Running Morpheus Pipeline with OpenAI LLM service

```bash

python examples/llm/main.py completion pipeline --llm_service OpenAI
```
8 changes: 0 additions & 8 deletions examples/llm/rag/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,14 +96,6 @@ The standalone Morpheus pipeline is built using the following components:

Before running the pipeline, we need obtain service API keys for the following services:

### Ensure that LFS files are downloaded

To retrieve datasets from LFS run the following:

```bash
./scripts/fetch_data.py fetch datasets
```

### Obtain an OpenAI API or NGC API Key

#### NGC
Expand Down
13 changes: 9 additions & 4 deletions examples/llm/vdb_upload/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,16 +123,21 @@ Before running the pipeline, we need to ensure that the following services are r

#### Ensure LFS files are downloaded

To retrieve datasets from LFS run the following:
To retrieve the datasets from LFS run the following:

```bash
./scripts/fetch_data.py fetch datasets
./scripts/fetch_data.py fetch examples
```

#### Milvus Service

- Follow the instructions [here](https://milvus.io/docs/install_standalone-docker.md) to install and run a Milvus
service.
- Refer to the [Milvus documentation](https://milvus.io/docs/install-overview.md) for more details on running Milvus. For the purposes of testing the pipeline, we will launch an instance of Milvus Lite.

From the root of the Morpheus repository, run the following to launch Milvus in a separate terminal:
```bash
mkdir -p .tmp/milvusdb
milvus-server --data .tmp/milvusdb
```

#### Triton Service

Expand Down

0 comments on commit 13c7268

Please sign in to comment.