NVIDIA Morpheus (24.10.01)
(Latest Version)

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 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.

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 library, you can run the following commands:

Create a Conda Environment

Copy
Copied!
            

export CONDA_ENV_NAME=morpheus conda create -n ${CONDA_ENV_NAME} python=3.10 conda activate ${CONDA_ENV_NAME}

Add Conda Channels

These channels are required for installing the runtime dependencies:

Copy
Copied!
            

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

Copy
Copied!
            

conda install -c nvidia morpheus-core=24.10

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 and 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:

Copy
Copied!
            

MORPHEUS_CORE_PKG_DIR=$(dirname $(python -c "import morpheus; print(morpheus.__file__)")) pip install -r ${MORPHEUS_CORE_PKG_DIR}/requirements_morpheus_core.txt

Digital Finger Printing (DFP) is a technique used to identify anomalous behavior and uncover potential threats in the environment​. The morpheus-dfp library contains stages for DFP. It is built from the source code in the python/morpheus_dfp directory of the Morpheus repository. To set up a Conda environment with the morpheus-dfp library, you can run the following commands:

Create a Conda Environment

Copy
Copied!
            

export CONDA_ENV_NAME=morpheus-dfp conda create -n ${CONDA_ENV_NAME} python=3.10 conda activate ${CONDA_ENV_NAME}

Add Conda Channels

These channels are required for installing the runtime dependencies:

Copy
Copied!
            

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-dfp Library

Copy
Copied!
            

conda install -c nvidia morpheus-dfp=24.10

The morpheus-dfp Conda package installs the morpheus_dfp Python package. It also pulls down all the necessary Conda runtime dependencies including morpheus-core.

Install Additional PyPI dependencies

Some of the DFP stages in the library require additional dependencies that are hosted on PyPI. These dependencies are included as a requirements file in the morpheus_dfp Python package. It can be installed by running the following command:

Copy
Copied!
            

MORPHEUS_DFP_PKG_DIR=$(dirname $(python -c "import morpheus_dfp; print(morpheus_dfp.__file__)")) pip install -r ${MORPHEUS_DFP_PKG_DIR}/requirements_morpheus_dfp.txt

The morpheus-llm library contains stages for Large Language Models (LLM) and Vector Databases. These stages are used for setting up Retrieval Augmented Generation (RAG) pipelines. The morpheus-llm library is built from the source code in the python/morpheus_llm directory of the Morpheus repository. To set up a Conda environment with the morpheus-llm library, you can run the following commands:

Create a Conda Environment

Copy
Copied!
            

export CONDA_ENV_NAME=morpheus-llm conda create -n ${CONDA_ENV_NAME} python=3.10 conda activate ${CONDA_ENV_NAME}

Add Conda Channels

These channels are required for installing the runtime dependencies:

Copy
Copied!
            

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-llm Library

Copy
Copied!
            

conda install -c nvidia morpheus-llm=24.10

The morpheus-llm Conda package installs the morpheus_llm python package. It also pulls down all the necessary Conda packages including morpheus-core.

Install Additional PyPI Dependencies

Some of the stages in the library require additional dependencies that are hosted on PyPI. These dependencies are included as a requirements file in the morpheus_llm Python package. It can be installed by running the following command:

Copy
Copied!
            

MORPHEUS_LLM_PKG_DIR=$(dirname $(python -c "import morpheus_llm; print(morpheus_llm.__file__)")) pip install -r ${MORPHEUS_LLM_PKG_DIR}/requirements_morpheus_llm.txt

Morpheus Examples

The Morpheus examples are not included in the Morpheus Conda packages. To use them, you need to clone the Morpheus repository and run the examples from source. For details, refer to the Morpheus Examples.

Namespace Updates

If you were using a Morpheus release prior to 24.10 you may need to update the namespace for the DFP, LLM, and vector database stages.

A script, scripts/morpheus_namespace_update.py, has been provided, and can be run with following commands:

Copy
Copied!
            

python scripts/morpheus_namespace_update.py --directory <directory> --dfp

Copy
Copied!
            

python scripts/morpheus_namespace_update.py --directory <directory> --llm

Previous Getting Started with Morpheus
Next Morpheus CLI Overview
© Copyright 2024, NVIDIA. Last updated on Dec 3, 2024.