Skip to content

Commit

Permalink
Cleanup docs so that each as a single H1 title (#1794)
Browse files Browse the repository at this point in the history
* This fixes the way the documents appear in the TOC

## 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:
  - Eli Fajardo (https://github.com/efajardo-nv)

URL: #1794
  • Loading branch information
dagardner-nv authored Jul 3, 2024
1 parent 84efdc6 commit d9ca30f
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 5 deletions.
5 changes: 4 additions & 1 deletion docs/source/examples/llm/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,12 @@ LLM
.. toctree::
:maxdepth: 20

./README.md
./completion/README.md
./vdb_upload/README.md
./rag/README.md
./agents/README.md

.. toctree::
:hidden:

./README.md
5 changes: 2 additions & 3 deletions examples/doca/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The container must be run in privileged mode and mount in hugepages as configure
docker run -v /dev/hugepages:/dev/hugepages --privileged --rm -ti --runtime=nvidia --net=host --gpus=all --cap-add=sys_nice ${MORPHEUS_DOCA_IMAGE} bash
```

# Preparing the environment
## Preparing the environment

Prior to running the example, the `rdma-core` conda package needs to be _removed by force_ from the conda environment, otherwise the environment is incompatible with the DOCA-provided packages.
```
Expand Down Expand Up @@ -170,9 +170,8 @@ Added stage: <monitor-9; MonitorStage(description=AddClass rate, smoothing=0.05,
Stopping pipeline. Please wait... Press Ctrl+C again to kill.
DOCA GPUNetIO rate: 0 pkts [00:09, ? pkts/s]
Deserialize rate: 0 pkts [00:09, ? pkts/s]
Tokenize rate: 0 pkts [00:09, ? pkts/s]
Tokenize rate: 0 pkts [00:09, ? pkts/s]
Inference rate: 0 pkts [00:09, ? pkts/s]
AddClass rate: 0 pkts [00:09, ? pkts/s]
```
The output can be found in `doca_output.csv`

2 changes: 1 addition & 1 deletion examples/llm/agents/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ All environments require additional Conda packages which can be installed with e
| Morpheus Release Container || |
| Dev Container || |

# Background Information
## Background Information

### Purpose
The Morpheus LLM Agents pipeline is designed to seamlessly integrate Large Language Model (LLM) agents into the Morpheus framework. This implementation focuses on efficiently executing multiple LLM queries using the ReAct agent type, which is tailored for versatile task handling. The use of the Langchain library streamlines the process, minimizing the need for additional system migration.
Expand Down
2 changes: 2 additions & 0 deletions examples/llm/completion/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ See the License for the specific language governing permissions and
limitations under the License.
-->

# Completion Pipeline

## Table of Contents

1. [Background Information](#background-information)
Expand Down

0 comments on commit d9ca30f

Please sign in to comment.