|
| 1 | +<!-- |
| 2 | +SPDX-FileCopyrightText: Copyright (c) 2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved. |
| 3 | +SPDX-License-Identifier: Apache-2.0 |
| 4 | +
|
| 5 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | +you may not use this file except in compliance with the License. |
| 7 | +You may obtain a copy of the License at |
| 8 | +
|
| 9 | +http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | +
|
| 11 | +Unless required by applicable law or agreed to in writing, software |
| 12 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | +See the License for the specific language governing permissions and |
| 15 | +limitations under the License. |
| 16 | +--> |
| 17 | + |
| 18 | +# Morpheus Conda Packages |
| 19 | +The Morpheus stages are the building blocks for creating pipelines. The stages are organized into libraries by use case. The current libraries are: |
| 20 | +- `morpheus-core` |
| 21 | +- `morpheus-dfp` |
| 22 | +- `morpheus-llm` |
| 23 | + |
| 24 | +The libraries are hosted as Conda packages on the [`nvidia`](https://anaconda.org/nvidia/) channel. |
| 25 | + |
| 26 | +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. |
| 27 | + |
| 28 | + |
| 29 | +## Morpheus Core |
| 30 | +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. |
| 31 | +To set up a Conda environment with the [`morpheus-core`](https://anaconda.org/nvidia/morpheus-core) library you can run the following commands: |
| 32 | +### Create a Conda environment |
| 33 | +```bash |
| 34 | +export CONDA_ENV_NAME=morpheus |
| 35 | +conda create -n ${CONDA_ENV_NAME} python=3.10 |
| 36 | +conda activate ${CONDA_ENV_NAME} |
| 37 | +``` |
| 38 | +### Add Conda channels |
| 39 | +These channel are required for installing the runtime dependencies |
| 40 | +```bash |
| 41 | +conda config --env --add channels conda-forge &&\ |
| 42 | + conda config --env --add channels nvidia &&\ |
| 43 | + conda config --env --add channels rapidsai &&\ |
| 44 | + conda config --env --add channels pytorch |
| 45 | +``` |
| 46 | +### Install the `morpheus-core` library |
| 47 | +```bash |
| 48 | +conda install -c nvidia morpheus-core |
| 49 | +``` |
| 50 | +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). |
| 51 | +### Install additional PyPI dependencies |
| 52 | +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: |
| 53 | +```bash |
| 54 | +MORPHEUS_CORE_PKG_DIR=$(dirname $(python -c "import morpheus; print(morpheus.__file__)")) |
| 55 | +pip install -r ${MORPHEUS_CORE_PKG_DIR}/requirements_morpheus_core.txt |
| 56 | +``` |
| 57 | + |
| 58 | +## Morpheus DFP |
| 59 | +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`](https://anaconda.org/nvidia/morpheus-dfp) library you can run the following commands: |
| 60 | +### Create a Conda environment |
| 61 | +```bash |
| 62 | +export CONDA_ENV_NAME=morpheus-dfp |
| 63 | +conda create -n ${CONDA_ENV_NAME} python=3.10 |
| 64 | +conda activate ${CONDA_ENV_NAME} |
| 65 | +``` |
| 66 | +### Add Conda channels |
| 67 | +These channel are required for installing the runtime dependencies |
| 68 | +```bash |
| 69 | +conda config --env --add channels conda-forge &&\ |
| 70 | + conda config --env --add channels nvidia &&\ |
| 71 | + conda config --env --add channels rapidsai &&\ |
| 72 | + conda config --env --add channels pytorch |
| 73 | +``` |
| 74 | +### Install the `morpheus-dfp` library |
| 75 | +```bash |
| 76 | +conda install -c nvidia morpheus-dfp |
| 77 | +``` |
| 78 | +The `morpheus-dfp` Conda package installs the `morpheus_dfp` python package. It also pulls down all the necessary Conda runtime dependencies including [`morpheus-core`](https://anaconda.org/nvidia/morpheus-core). |
| 79 | +### Install additional PyPI dependencies |
| 80 | +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. And can be installed by running the following command: |
| 81 | +```bash |
| 82 | +MORPHEUS_DFP_PKG_DIR=$(dirname $(python -c "import morpheus_dfp; print(morpheus_dfp.__file__)")) |
| 83 | +pip install -r ${MORPHEUS_DFP_PKG_DIR}/requirements_morpheus_dfp.txt |
| 84 | +``` |
| 85 | + |
| 86 | +## Morpheus LLM |
| 87 | +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. |
| 88 | +To set up a Conda environment with the [`morpheus-llm`](https://anaconda.org/nvidia/morpheus-dfp) library you can run the following commands: |
| 89 | +### Create a Conda environment |
| 90 | +```bash |
| 91 | +export CONDA_ENV_NAME=morpheus-llm |
| 92 | +conda create -n ${CONDA_ENV_NAME} python=3.10 |
| 93 | +conda activate ${CONDA_ENV_NAME} |
| 94 | +``` |
| 95 | +### Add Conda channels |
| 96 | +These channel are required for installing the runtime dependencies |
| 97 | +```bash |
| 98 | +conda config --env --add channels conda-forge &&\ |
| 99 | + conda config --env --add channels nvidia &&\ |
| 100 | + conda config --env --add channels rapidsai &&\ |
| 101 | + conda config --env --add channels pytorch |
| 102 | +``` |
| 103 | +### Install the `morpheus-llm` library |
| 104 | +```bash |
| 105 | +conda install -c nvidia morpheus-llm |
| 106 | +``` |
| 107 | +The `morpheus-llm` Conda package installs the `morpheus_llm` python package. It also pulls down all the necessary Conda packages including [`morpheus-core`](https://anaconda.org/nvidia/morpheus-core). |
| 108 | +### Install additional PyPI dependencies |
| 109 | +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. And can be installed by running the following command: |
| 110 | +```bash |
| 111 | +MORPHEUS_LLM_PKG_DIR=$(dirname $(python -c "import morpheus_llm; print(morpheus_llm.__file__)")) |
| 112 | +pip install -r ${MORPHEUS_LLM_PKG_DIR}/requirements_morpheus_llm.txt |
| 113 | +``` |
| 114 | + |
| 115 | +## Miscellaneous |
| 116 | +### Morpheus Examples |
| 117 | +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](./examples.md). |
| 118 | + |
| 119 | +### Namespace Updates |
| 120 | +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. |
| 121 | + |
| 122 | +A script, `scripts/morpheus_namespace_update.py`, has been provide to help with that and can be run as follows: |
| 123 | +```bash |
| 124 | +python scripts/morpheus_namespace_update.py --directory <directory> --dfp |
| 125 | +``` |
| 126 | +```bash |
| 127 | +python scripts/morpheus_namespace_update.py --directory <directory> --llm |
| 128 | +``` |
0 commit comments