diff --git a/docs/source/conda_packages.md b/docs/source/conda_packages.md index b008d52184..ff3a03d83b 100644 --- a/docs/source/conda_packages.md +++ b/docs/source/conda_packages.md @@ -17,25 +17,25 @@ limitations under the License. # 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 +- `morpheus-core` +- `morpheus-dfp` +- `morpheus-llm` -The libraries are hosted as conda packages on the [nvidia](https://anaconda.org/nvidia/) channel. +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 +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 +### Add Conda channels These channel are required for installing the runtime dependencies ```bash conda config --env --add channels conda-forge &&\ @@ -43,13 +43,13 @@ conda config --env --add channels conda-forge &&\ conda config --env --add channels rapidsai &&\ conda config --env --add channels pytorch ``` -### Install the morpheus-core library +### 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: +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 <