Skip to content

Commit 2396151

Browse files
authored
Document the licences of additional dependencies (#2295)
## By Submitting this PR I confirm: - I am familiar with the [Contributing Guidelines](https://github.com/nv-morpheus/Morpheus/blob/main/docs/source/developer_guide/contributing.md). - When the PR is ready for review, new or existing tests cover these changes. - When the PR is ready for review, the documentation is up to date with these changes. Authors: - David Gardner (https://github.com/dagardner-nv) Approvers: - Will Killian (https://github.com/willkill07) URL: #2295
1 parent 44a17db commit 2396151

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

examples/data_loss_prevention/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Below is a visualization of the pipeline showing all stages and data flow:
104104

105105
### Installing GliNER and dependencies
106106

107-
Prior to running the DLP pipeline, additional requirements must be installed in to your Conda environment.
107+
Prior to running the DLP pipeline, additional requirements must be installed in to your Conda environment. This will download and install additional third-party open source software projects. Review the license terms of these open source projects before use.
108108

109109
```bash
110110
conda env update --solver=libmamba \
@@ -119,6 +119,8 @@ pip install --no-deps gliner==0.2.21
119119

120120
### Downloading the model (optional)
121121

122+
The model being used is [gretelai/gretel-gliner-bi-small-v1.0](https://huggingface.co/gretelai/gretel-gliner-bi-small-v1.0) which is released under the [Apache License 2.0](https://huggingface.co/datasets/choosealicense/licenses/blob/main/markdown/apache-2.0.md).
123+
122124
Users who are using the pre-built Morpheus Docker container should skip this step. Downloading the model locally offers a slight performance benefit, otherwise the model is fetched on-demand, then on subsequent runs a cached copy of the model is used.
123125

124126
The model is stored in the Morpheus repository using [Git Large File Storage (LFS)](https://git-lfs.github.com/). Only those files which are strictly needed to run Morpheus are downloaded by default when the repository is cloned. The model can be downloaded using the `fetch_data.py` script.
@@ -128,6 +130,7 @@ git lfs install
128130
./scripts/fetch_data.py fetch models
129131
```
130132

133+
131134
### Build the Example
132135

133136
#### Building the example by itself
@@ -219,6 +222,9 @@ Options:
219222
--help Show this message and exit.
220223
```
221224

225+
226+
> **Note**: By default when the `--input_file` and `--dataset` flags are not set, the [gretelai/gretel-pii-masking-en-v1](https://huggingface.co/datasets/gretelai/gretel-pii-masking-en-v1) dataset will be fetched at runtime. This dataset is released under the [Apache License 2.0](https://huggingface.co/datasets/choosealicense/licenses/blob/main/markdown/apache-2.0.md).
227+
222228
To launch the configured Morpheus pipeline with the default arguments, run the following:
223229

224230
```bash

0 commit comments

Comments
 (0)