Skip to content

Commit

Permalink
23.01 doc fixes (#652)
Browse files Browse the repository at this point in the history
Addresses PR comments in #646

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

Approvers:
  - Devin Robison (https://github.com/drobison00)
  - Eli Fajardo (https://github.com/efajardo-nv)
  - Pete MacKinnon (https://github.com/pdmack)

URL: #652
  • Loading branch information
dagardner-nv authored Jan 30, 2023
1 parent 312bfba commit 05c4ca8
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 19 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
SPDX-FileCopyrightText: Copyright (c) 2022, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-FileCopyrightText: Copyright (c) 2022-2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: Apache-2.0
Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -25,17 +25,17 @@ NVIDIA Morpheus is an open AI application framework that provides cybersecurity
### Using Morpheus
* [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.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
* [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
* [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


### Modifying Morpheus
* [Contributing to Morpheus](./CONTRIBUTING.md) - Covers building from source, making changes and contributing to Morpheus
* [Contributing to Morpheus](./docs/source/developer_guide/contributing.md) - Covers building from source, making changes and contributing to Morpheus

### Deploying Morpheus
* [Deployment Guide](./docs/source/cloud_deployment_guide.md) - Kubernetes and cloud based deployments
* [Morpheus Cloud Deployment Guide](./docs/source/cloud_deployment_guide.md) - Kubernetes and cloud based deployments


Full documentation for the latest official release is available at [https://docs.nvidia.com/morpheus/](https://docs.nvidia.com/morpheus/).
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

Additional packages required for building the documentation are defined in `./conda_docs.yml`.

## Get additional dependency
## Install Additional Dependencies
From the root of the morpheus repo:
```bash
mamba env update -f docs/conda_docs.yml
Expand Down
18 changes: 10 additions & 8 deletions docs/source/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,28 +33,30 @@ More advanced users, or those who are interested in using the latest pre-release
- [The NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html#docker)
- [NVIDIA Triton Inference Server](https://catalog.ngc.nvidia.com/orgs/nvidia/containers/tritonserver) `22.06` or higher

#### Note about Docker:
> **Note about Docker:**
>
> The Morpheus documentation and examples assume that the [Manage Docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) post install step has been performed allowing Docker commands to be executed by a non-root user. This is not strictly necessary so long as the current user has `sudo` privileges to execute Docker commands.
## Using pre-built Docker containers
### Pull the Morpheus Image
1. Go to [https://catalog.ngc.nvidia.com/orgs/nvidia/teams/morpheus/containers/morpheus/tags](https://catalog.ngc.nvidia.com/orgs/nvidia/teams/morpheus/containers/morpheus/tags)
1. Choose a version
1. Download the selected version, for example for `22.11`:
1. Download the selected version, for example for `23.01`:
```bash
docker pull nvcr.io/nvidia/morpheus/morpheus:22.11-runtime
docker pull nvcr.io/nvidia/morpheus/morpheus:23.01-runtime
```

#### Note about Morpheus versions:
> Morpheus uses Calendar Versioning ([CalVer](https://calver.org/)). For each Morpheus release there will be an image tagged in the form of `YY.MM-runtime` this tag will always refer to the latest point release for that version. In addition to this there will also be at least one point release version tagged in the form of `vYY.MM.00-runtime` this will be the initial point release for that version (ex. `v22.11.00-runtime`). In the event of a major bug, we may release additional point releases (ex. `v22.11.01-runtime`, `v22.11.02-runtime` etc...), and the `YY.MM-runtime` tag will be updated to reference that point release.
> **Note about Morpheus versions:**
>
> Morpheus uses Calendar Versioning ([CalVer](https://calver.org/)). For each Morpheus release there will be an image tagged in the form of `YY.MM-runtime` this tag will always refer to the latest point release for that version. In addition to this there will also be at least one point release version tagged in the form of `vYY.MM.00-runtime` this will be the initial point release for that version (ex. `v23.01.00-runtime`). In the event of a major bug, we may release additional point releases (ex. `v23.01.01-runtime`, `v23.01.02-runtime` etc...), and the `YY.MM-runtime` tag will be updated to reference that point release.
>
> Users who want to ensure they are running with the latest bug fixes should use a release image tag (`YY.MM-runtime`). Users who need to deploy a specific version into production should use a point release image tag (`vYY.MM.00-runtime`).
### Starting the Morpheus Container
1. Ensure that [The NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html#docker) is installed.
1. Start the container downloaded from the previous section:
```bash
docker run --rm -ti --runtime=nvidia --gpus=all --net=host -v /var/run/docker.sock:/var/run/docker.sock nvcr.io/nvidia/morpheus/morpheus:22.11-runtime bash
docker run --rm -ti --runtime=nvidia --gpus=all --net=host -v /var/run/docker.sock:/var/run/docker.sock nvcr.io/nvidia/morpheus/morpheus:23.01-runtime bash
```

Note about some of the flags above:
Expand Down Expand Up @@ -131,10 +133,10 @@ To run the built "release" container, use the following:
./docker/run_container_release.sh
```

The `./docker/run_container_release.sh` script accepts the same `DOCKER_IMAGE_NAME`, and `DOCKER_IMAGE_TAG` environment variables that the `./docker/build_container_release.sh` script does. For example, to run version `v22.11.00a` use the following:
The `./docker/run_container_release.sh` script accepts the same `DOCKER_IMAGE_NAME`, and `DOCKER_IMAGE_TAG` environment variables that the `./docker/build_container_release.sh` script does. For example, to run version `v23.01.00a` use the following:

```bash
DOCKER_IMAGE_TAG="v22.11.00a-runtime" ./docker/run_container_release.sh
DOCKER_IMAGE_TAG="v23.01.00a-runtime" ./docker/run_container_release.sh
```

## Launching Triton Server
Expand Down
4 changes: 0 additions & 4 deletions examples/sid_visualization/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,6 @@ git submodule update --init --recursive
Before launching the demo, we need the dev container for Morpheus to be created:
```bash
export DOCKER_IMAGE_TAG="sid-viz"
```

# Build the dev container
```bash
./docker/build_container_dev.sh
```

Expand Down

0 comments on commit 05c4ca8

Please sign in to comment.