Skip to content

Commit

Permalink
Model and dataset documentation update (#612)
Browse files Browse the repository at this point in the history
Fixes Issue #567

Authors:
  - https://github.com/shawn-davis

Approvers:
  - David Gardner (https://github.com/dagardner-nv)

URL: #612
  • Loading branch information
shawn-davis authored Jan 20, 2023
1 parent af41d35 commit 446a436
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions docs/source/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <examples>` - Example pipelines using both the Python API and command line interface
* :doc:`Pretrained Models <models_and_datasets>` - Pretrained models with corresponding training, validation scripts, and datasets
* :doc:`Developer Guides <developer_guide/guides>` - Covers extending Morpheus with custom stages

Modifying Morpheus
Expand Down
3 changes: 3 additions & 0 deletions docs/source/models_and_datasets.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit 446a436

Please sign in to comment.