From fff7c63e560215fade01b76200219c95c556dac0 Mon Sep 17 00:00:00 2001 From: David Gardner Date: Tue, 14 Nov 2023 13:32:56 -0800 Subject: [PATCH] Revert "The top-level README should direct users to the examples dir as this is the entry-point for github viewers" This reverts commit 609301b07d44df724efc4dac5abd20220e125ee8. --- README.md | 2 +- examples/README.md | 16 +++++++--------- 2 files changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 945d9eb112..6a5c374cb5 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ NVIDIA Morpheus is an open AI application framework that provides cybersecurity * [Getting Started with Morpheus](./docs/source/getting_started.md) - Using pre-built Docker containers, building Docker containers from source, and fetching models and datasets * [Morpheus CLI Overview](./docs/source/basics/overview.rst) - Brief overview of the `morpheus` command line interface * [Building a Pipeline](./docs/source/basics/building_a_pipeline.md) - Introduction to building a pipeline using the command line interface -* [Morpheus Examples](./examples/README.md) - Example pipelines using both the Python API and command line interface +* [Morpheus Examples](./docs/source/examples.md) - Example pipelines using both the Python API and command line interface * [Pre-built Models and Datasets](./models/README.md) - Pretrained models with corresponding training, validation scripts, and datasets * [Developer Guides](./docs/source/developer_guide/guides.md) - Covers extending Morpheus with custom stages diff --git a/examples/README.md b/examples/README.md index 47dd3adf15..c80d88ee9f 100644 --- a/examples/README.md +++ b/examples/README.md @@ -15,12 +15,10 @@ See the License for the specific language governing permissions and limitations under the License. --> -# Examples -* [Anomalous Behavior Profiling with Forest Inference Library (FIL) Example](./abp_nvsmi_detection/README.md) -* [ABP Detection Example Using Morpheus](./abp_pcap_detection/README.md) -* [GNN Fraud Detection Pipeline](./gnn_fraud_detection_pipeline/README.md) -* [Example cyBERT Morpheus Pipeline for Apache Log Parsing](./log_parsing/README.md) -* [Sensitive Information Detection with Natural Language Processing (NLP) Example](./nlp_si_detection/README.md) -* [Example Ransomware Detection Morpheus Pipeline for AppShield Data](./ransomware_detection/README.md) -* [Root Cause Analysis Acceleration & Predictive Maintenance Example](./root_cause_analysis/README.md) -* [SID Visualization Example](./sid_visualization/README.md) +## Morpheus CLI Examples + +Examples run with the Morpheus CLI (`morpheus ...`) should be run from the repository root; otherwise, some filepath arguments may need to be changed. + +## Morpheus run.py Examples + +Examples run with python (`python run.py`) should be run from the example's directory; otherwise, relative Python imports may be broken.