Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stage documentation improvements #1362

Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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](./docs/source/examples.md) - Example pipelines using both the Python API and command line interface
* [Morpheus Examples](./examples/README.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

Expand Down
4 changes: 2 additions & 2 deletions docs/source/developer_guide/guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ limitations under the License.
## Morpheus Stages

Morpheus includes a number of pre-defined stage implementations to choose from when building a custom
pipeline, each of which can be included and configured to suit your application.
pipeline, each of which can be included and configured to suit your application. The stages included in Morpheus can be found in the stages API reference:

- [List of available Morpheus stages](../stages/morpheus_stages.md)
- [Morpheus stages API](../_modules/morpheus.stages)

There are likely going to be situations that require writing a custom stage. Morpheus stages are written in
Python and optionally may include a C++ implementation. The following guides outline how to create your own stages
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Deploying Morpheus
:maxdepth: 20
:hidden:

stages/morpheus_stages
_modules/morpheus.stages

.. toctree::
:caption: Morpheus Modules
Expand Down
81 changes: 0 additions & 81 deletions docs/source/stages/morpheus_stages.md
drobison00 marked this conversation as resolved.
Show resolved Hide resolved

This file was deleted.

16 changes: 9 additions & 7 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,12 @@ See the License for the specific language governing permissions and
limitations under the License.
-->

## 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.
# 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)
Loading