diff --git a/docs/source/conda_packages.md b/docs/source/conda_packages.md new file mode 100644 index 0000000000..8ed8075ae0 --- /dev/null +++ b/docs/source/conda_packages.md @@ -0,0 +1,123 @@ +# Morpheus Conda Packages +The Morpheus stages are the building blocks for creating pipelines. The stages are organized into libraries by use case. The current libraries are: +- morpheus-core +- morpheus-dfp +- morpheus-llm + +The libraries are hosted as conda packages on the [nvidia](https://anaconda.org/nvidia/) channel. + +The split into multiple libraries allows for a more modular approach to using the Morpheus stages. For example, if you are building an application for Digital Finger Printing, you can install just the `morpheus-dfp` library. This reduces the size of the installed package. It also limits the dependencies eliminating unnecessary version conflicts. + + +## Morpheus Core +The `morpheus-core` library contains the core stages that are common across all use cases. The Morpheus core library is built from the source code in the `python/morpheus` directory of the Morpheus repository. The core library is installed as a dependency when you install any of the other Morpheus libraries. +To set up a conda environment with the [morpheus-core](https://anaconda.org/nvidia/morpheus-core) library you can run the following commands: +### Create a conda environment +```bash +export CONDA_ENV_NAME=morpheus +conda create -n $CONDA_ENV_NAME python=3.10 +conda activate $CONDA_ENV_NAME +``` +### Add conda channels +These channel are required for installing the runtime dependencies +```bash +conda config --env --add channels conda-forge &&\ + conda config --env --add channels nvidia &&\ + conda config --env --add channels rapidsai &&\ + conda config --env --add channels pytorch +``` +### Install the morpheus-core library +```bash +conda install -c nvidia morpheus-core +``` +The `morpheus-core` conda package installs the `morpheus` python package. It also pulls down all the necessary conda runtime dependencies for the core stages including [mrc](https://anaconda.org/nvidia/mrc) and [libmrc](https://anaconda.org/nvidia/libmrc). +### Install additional pypi dependencies +Some of the stages in the core library require additional dependencies that are hosted on Pypi. These dependencies are included as a requirements file in the morpheus python package. The requirements files can be located and installed by running the following command: +```bash +python3 < --dfp +``` +```bash +python scripts/morpheus_namespace_update.py --directory --llm +``` diff --git a/docs/source/getting_started.md b/docs/source/getting_started.md index 9478f7d426..f97a30350e 100644 --- a/docs/source/getting_started.md +++ b/docs/source/getting_started.md @@ -19,7 +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) +- [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) @@ -80,7 +80,10 @@ 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 +The Morpheus stages are available as libraries that are hosted as conda packages on the [NVIDIA](https://anancon) channel. The Morpheus conda packages are: +[morpheus-core](https://anaconda.org/nvidia/morpheus-core), [morpheus-dfp](https://anaconda.org/nvidia/morpheus-dfp) and [morpheus-llm](https://anaconda.org/nvidia/morpheus-llm) + +For details on these libraries and how to use them, refer to the [Morpheus Conda Packages](./conda_packages.md) guide. ## Building the Morpheus Container ### Clone the Repository diff --git a/docs/source/index.rst b/docs/source/index.rst index fae48cc6b0..dce4a88bfd 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -54,6 +54,7 @@ Getting Started Using Morpheus ^^^^^^^^^^^^^^ * :doc:`getting_started` - Using pre-built Docker containers, building Docker containers from source, and fetching models and datasets + * :doc:`Morpheus Conda Packages `- Using Morpheus Libraries via the pre-built Conda Packages * :doc:`basics/overview` - Brief overview of the command line interface * :doc:`basics/building_a_pipeline` - Introduction to building a pipeline using the command line interface * :doc:`Morpheus Examples ` - Example pipelines using both the Python API and command line interface @@ -76,6 +77,7 @@ Deploying Morpheus :hidden: getting_started + conda_packages basics/overview basics/building_a_pipeline models_and_datasets