From 570a770b5e26197ac8ab4c65777376696c36a486 Mon Sep 17 00:00:00 2001 From: Anuradha Karuppiah Date: Thu, 17 Oct 2024 23:48:38 +0000 Subject: [PATCH] Doc updates post compartmentalization Signed-off-by: Anuradha Karuppiah --- docs/CMakeLists.txt | 4 ++-- docs/source/getting_started.md | 4 ++++ docs/source/py_api.rst | 1 + docs/source/stages/morpheus_stages.md | 2 +- 4 files changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 41aa33a535..f2fce41612 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -30,7 +30,7 @@ add_custom_target(${PROJECT_NAME}_docs BUILD_DIR=${CMAKE_CURRENT_BINARY_DIR} ${SPHINX_EXECUTABLE} ${SPHINX_HTML_ARGS} ${SPHINX_SOURCE} ${SPHINX_BUILD} WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} COMMENT "Generating documentation with Sphinx" - DEPENDS morpheus-package-outputs morpheus_llm-package-outputs + DEPENDS morpheus-package-outputs morpheus_llm-package-outputs morpheus_dfp-pacakage-outputs ) add_custom_target(${PROJECT_NAME}_docs_linkcheck @@ -38,7 +38,7 @@ add_custom_target(${PROJECT_NAME}_docs_linkcheck BUILD_DIR=${CMAKE_CURRENT_BINARY_DIR} ${SPHINX_EXECUTABLE} ${SPHINX_LINKCHECK_ARGS} ${SPHINX_SOURCE} ${SPHINX_LINKCHECK_OUT} WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} COMMENT "Checking documentation links with Sphinx" - DEPENDS morpheus-package-outputs morpheus_llm-package-outputs + DEPENDS morpheus-package-outputs morpheus_llm-package-outputs morpheus_dfp-pacakage-outputs ) list(POP_BACK CMAKE_MESSAGE_CONTEXT) diff --git a/docs/source/getting_started.md b/docs/source/getting_started.md index b4d2b04cab..9478f7d426 100644 --- a/docs/source/getting_started.md +++ b/docs/source/getting_started.md @@ -19,6 +19,7 @@ limitations under the License. There are three ways to get started with Morpheus: - [Using pre-built Docker containers](#using-pre-built-docker-containers) +- [Using the morpheus conda packages](#using-morpheus-conda-packages) - [Building the Morpheus Docker container](#building-the-morpheus-container) - [Building Morpheus from source](./developer_guide/contributing.md#building-from-source) @@ -78,6 +79,9 @@ Once launched, users wishing to launch Triton using the included Morpheus models Skip ahead to the [Acquiring the Morpheus Models Container](#acquiring-the-morpheus-models-container) section. +## Using Morpheus Conda Packages +TBD + ## Building the Morpheus Container ### Clone the Repository diff --git a/docs/source/py_api.rst b/docs/source/py_api.rst index e4aa991db2..e37d340216 100644 --- a/docs/source/py_api.rst +++ b/docs/source/py_api.rst @@ -22,4 +22,5 @@ Python API :recursive: morpheus + morpheus_dfp morpheus_llm diff --git a/docs/source/stages/morpheus_stages.md b/docs/source/stages/morpheus_stages.md index db2d533606..e860beff38 100644 --- a/docs/source/stages/morpheus_stages.md +++ b/docs/source/stages/morpheus_stages.md @@ -66,7 +66,7 @@ Stages are the building blocks of Morpheus pipelines. Below is a list of the mos ## LLM -- LLM Engine Stage {py:class}`~morpheus.stages.llm.llm_engine_stage.LLMEngineStage` Execute an LLM engine within a Morpheus pipeline. +- LLM Engine Stage {py:class}`~morpheus_llm.stages.llm.llm_engine_stage.LLMEngineStage` Execute an LLM engine within a Morpheus pipeline. ## Output - HTTP Client Sink Stage {py:class}`~morpheus.stages.output.http_client_sink_stage.HttpClientSinkStage` Write all messages to an HTTP endpoint.