From 446a43636adcf3709b7a4c690639e6982a5d2653 Mon Sep 17 00:00:00 2001 From: shawn-davis Date: Fri, 20 Jan 2023 11:41:09 -0500 Subject: [PATCH] Model and dataset documentation update (#612) Fixes Issue #567 Authors: - https://github.com/shawn-davis Approvers: - David Gardner (https://github.com/dagardner-nv) URL: https://github.com/nv-morpheus/Morpheus/pull/612 --- README.md | 2 ++ docs/source/getting_started.md | 1 + docs/source/index.rst | 1 + docs/source/models_and_datasets.md | 3 +++ 4 files changed, 7 insertions(+) create mode 100644 docs/source/models_and_datasets.md diff --git a/README.md b/README.md index 3a77d7cf3a..24c0d3c912 100644 --- a/README.md +++ b/README.md @@ -27,8 +27,10 @@ NVIDIA Morpheus is an open AI application framework that provides cybersecurity * [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.rst) - Introduction to building a pipeline using the command line interface * [Morpheus Examples](./examples.md) - Example pipelines using both the Python API and command line interface +* [Pre-built Models and Datasets](./models) - Pretrained models with corresponding training, validation scripts, and datasets * [Developer Guides](./docs/source/developer_guide/guides.md) - Covers extending Morpheus with custom stages + ### Modifying Morpheus * [Contributing to Morpheus](./CONTRIBUTING.md) - Covers building from source, making changes and contributing to Morpheus diff --git a/docs/source/getting_started.md b/docs/source/getting_started.md index 2cb3ca893e..45dbea5145 100644 --- a/docs/source/getting_started.md +++ b/docs/source/getting_started.md @@ -367,4 +367,5 @@ Note: The available commands for different types of pipelines are not the same. ## Next Steps * [Morpheus Examples](./examples.md) - Example pipelines using both the Python API and command line interface +* [Morpheus Pretrained Models](./models_and_datasets.md) - Pretrained models with corresponding training, validation scripts, and datasets * [Morpheus Developer Guide](./developer_guide/guides.md) - Documentation on using the Morpheus Python & C++ APIs diff --git a/docs/source/index.rst b/docs/source/index.rst index ba2b5878a0..e6f186d221 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -57,6 +57,7 @@ Using Morpheus * :doc:`basics/overview` - Brief overview of the command line interface * :doc:`basics/building_a_pipeline` - Introduction to building a pipeline using the command line interface * :doc:`Morpheus Examples ` - Example pipelines using both the Python API and command line interface + * :doc:`Pretrained Models ` - Pretrained models with corresponding training, validation scripts, and datasets * :doc:`Developer Guides ` - Covers extending Morpheus with custom stages Modifying Morpheus diff --git a/docs/source/models_and_datasets.md b/docs/source/models_and_datasets.md new file mode 100644 index 0000000000..841284a823 --- /dev/null +++ b/docs/source/models_and_datasets.md @@ -0,0 +1,3 @@ +# Morpheus Models + +Morpheus comes with a number of pretrained models with corresponding training, validation scripts, and datasets. The latest release of these models can be found [here](https://github.com/nv-morpheus/Morpheus/blob/-/models). \ No newline at end of file