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

Restructure the getting started guide #536

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
72 commits
Select commit Hold shift + click to select a range
0409bbf
removed the $ symbol from all bash commands
bsuryadevara Oct 11, 2022
a608298
Remove exclamation, and morpheus owns the docs
dagardner-nv Dec 2, 2022
74648f9
Include readme's from examples in the source
dagardner-nv Dec 2, 2022
fcb6e9c
Non-owning
dagardner-nv Dec 2, 2022
296e5cd
Replace usage of words like 'see' and 'look' in documentation
dagardner-nv Dec 6, 2022
254126b
Remove explcit calls to pipeline.build, this is no longer needed
dagardner-nv Dec 6, 2022
6fbeda7
Replace unseen with previously undetected
dagardner-nv Dec 6, 2022
9dedfb8
The logs are anonymized
dagardner-nv Dec 6, 2022
530b40e
Merge branch 'branch-23.01' into david-23.01-docs
dagardner-nv Dec 6, 2022
94da28d
Update the github url for Morpheus
dagardner-nv Dec 6, 2022
20b8651
Use main branch
dagardner-nv Dec 6, 2022
5b4080b
Add a toc link to the code of conduct
dagardner-nv Dec 7, 2022
12f2008
Shorten the title
dagardner-nv Dec 7, 2022
2363ee0
Merge branch 'branch-23.01' into david-23.01-docs-reorg
dagardner-nv Dec 7, 2022
8619f53
Merge branch 'branch-23.01' into david-23.01-docs
dagardner-nv Dec 7, 2022
9b40ad2
Move most of the contents of README to a new file under docs/source
dagardner-nv Dec 7, 2022
1c9cc13
Add getting_started & contributing guides
dagardner-nv Dec 7, 2022
c76a083
Link to developer guides from readme, guides doc converted from rst t…
dagardner-nv Dec 7, 2022
73507f6
Merge branch 'branch-23.01' into david-23.01-docs
dagardner-nv Dec 7, 2022
e4f7ddc
Merge branch 'david-23.01-docs' of github.com:dagardner-nv/Morpheus i…
dagardner-nv Dec 7, 2022
9781e58
Merge branch 'david-23.01-docs' into david-23.01-docs-reorg
dagardner-nv Dec 7, 2022
56502e7
Replace NGC intro with a list of getting started docs
dagardner-nv Dec 7, 2022
d5b9310
wip
dagardner-nv Dec 7, 2022
f37ee41
Move the contributing symlink
dagardner-nv Dec 7, 2022
9b0a9d9
wip
dagardner-nv Dec 7, 2022
4cd561d
wip
dagardner-nv Dec 7, 2022
e1602a7
Replace smart quotes
dagardner-nv Dec 7, 2022
c96429a
Sphinx wants the section to be named 'Examples' and it wants the inte…
dagardner-nv Dec 8, 2022
dac60f7
The myst parser doesn't like 'yml' as an alias for 'yaml'
dagardner-nv Dec 8, 2022
e653d64
Fix links
dagardner-nv Dec 8, 2022
c5ac203
TODO was causing a parse error in sphinx
dagardner-nv Dec 8, 2022
764e01f
Fix formatting for docstrings
dagardner-nv Dec 8, 2022
2d66cd5
Fix what appears to be a cut-off docstring
dagardner-nv Dec 8, 2022
3266860
Merge branch 'branch-23.01' into david-23.01-docs-reorg
dagardner-nv Dec 8, 2022
0f52edf
Misc docstring fixes
dagardner-nv Dec 8, 2022
19b2ef0
Restructure symlinks for examples, preventing name conflicts and addi…
dagardner-nv Dec 8, 2022
62ecd75
Removed usage of buffer
bsuryadevara Dec 8, 2022
4df69fe
Merge branch 'branch-23.01' into 524-doc-remove-usage-of-buffer-stage…
bsuryadevara Dec 8, 2022
aa8d452
Removed usage of buffer
bsuryadevara Dec 8, 2022
8a48e62
Removed usage of buffer
bsuryadevara Dec 8, 2022
3f1e456
Update link to options reference
dagardner-nv Dec 8, 2022
38b56b6
Update docs list
dagardner-nv Dec 8, 2022
a1189ab
updated monitor throughput image
bsuryadevara Dec 8, 2022
b147b77
Morpheus is the name of the project, and Morpheus is an SDK so "Morph…
dagardner-nv Dec 8, 2022
fe3b3f8
Morpheus is just Morpheus, removing SDK and SDK client
dagardner-nv Dec 8, 2022
33ac925
Update our elevator pitch paragraph to the version in the README.md file
dagardner-nv Dec 9, 2022
6af4992
Add license to md files
dagardner-nv Dec 9, 2022
8a63ca6
wip
dagardner-nv Dec 9, 2022
6a46175
wip
dagardner-nv Dec 9, 2022
298dd0b
Markdown doesn't support a table-of-contents that is usable in the na…
dagardner-nv Dec 9, 2022
46e14c5
wip
dagardner-nv Dec 9, 2022
87d950c
Remove usage of 'see'
dagardner-nv Dec 9, 2022
39a7984
Merge branch 'branch-23.01' into david-docs-23.01-getting-started
dagardner-nv Dec 9, 2022
2e6a785
replace referneces to the quickstart guide
dagardner-nv Dec 9, 2022
9b744b1
resolved conflicts
bsuryadevara Dec 9, 2022
7040acb
wip
dagardner-nv Dec 9, 2022
14245ed
resolved conflicts
bsuryadevara Dec 9, 2022
cb4b7f6
Merge branch '524-doc-remove-usage-of-buffer-stage-from-examplesrst' …
dagardner-nv Dec 9, 2022
3572442
Move the basics/examples.rst under the main examples to avoid having …
dagardner-nv Dec 10, 2022
978d2a2
symlink to include basic usage
dagardner-nv Dec 10, 2022
a2bdcc4
Add link to images
dagardner-nv Dec 10, 2022
4ba6c27
Merge branch 'branch-23.01' into david-docs-23.01-getting-started
dagardner-nv Dec 10, 2022
43c6737
Moving to lfs
dagardner-nv Dec 10, 2022
9031598
Update path to basic usage lfs images
dagardner-nv Dec 10, 2022
870dd4c
Moving to lfs
dagardner-nv Dec 10, 2022
437d50f
A few more tweaks
dagardner-nv Dec 10, 2022
14a8e55
Move links to the examples, feature them as one of the top-level links
dagardner-nv Dec 10, 2022
a9d9393
Merge branch 'branch-23.01' into david-23.01-docs-reorg
dagardner-nv Dec 13, 2022
7af783e
Merge branch 'david-23.01-docs-reorg' into david-23.01-docs-sdk
dagardner-nv Dec 13, 2022
14d97b6
Merge branch 'david-23.01-docs-sdk' into david-docs-23.01-getting-sta…
dagardner-nv Dec 13, 2022
df9cbe3
Merge branch 'branch-23.01' into david-docs-23.01-getting-started
dagardner-nv Dec 13, 2022
dfb0135
Having a custom stage no longer requires the python api
dagardner-nv Dec 13, 2022
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
Prev Previous commit
Next Next commit
Update the github url for Morpheus
  • Loading branch information
dagardner-nv committed Dec 6, 2022
commit 94da28d0a79a19fb0a755e962ef8d1de98a8c78e
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
Contributions to Morpheus fall into the following three categories.

1. To report a bug, request a new feature, or report a problem with
documentation, please file an [issue](https://github.com/NVIDIA/Morpheus/issues/new)
documentation, please file an [issue](https://github.com/nv-morpheus/Morpheus/issues/new)
describing in detail the problem or new feature. The Morpheus team evaluates
and triages issues, and schedules them for a release. If you believe the
issue needs priority attention, please comment on the issue to notify the
team.
2. To propose and implement a new Feature, please file a new feature request
[issue](https://github.com/NVIDIA/Morpheus/issues/new). Describe the
[issue](https://github.com/nv-morpheus/Morpheus/issues/new). Describe the
intended feature and discuss the design and implementation with the team and
community. Once the team agrees that the plan looks good, go ahead and
implement it, using the [code contributions](#code-contributions) guide below.
Expand All @@ -25,18 +25,18 @@ More information can be found at: [Contributor Code of Conduct](CODE_OF_CONDUCT.

### Your first issue

1. Find an issue to work on. The best way is to look for issues with the [good first issue](https://github.com/NVIDIA/Morpheus/issues) label.
1. Find an issue to work on. The best way is to look for issues with the [good first issue](https://github.com/nv-morpheus/Morpheus/issues) label.
2. Comment on the issue stating that you are going to work on it.
3. Code! Make sure to update unit tests! Ensure the [license headers are set properly](#Licensing).
4. When done, [create your pull request](https://github.com/NVIDIA/Morpheus/compare).
4. When done, [create your pull request](https://github.com/nv-morpheus/Morpheus/compare).
5. Wait for other developers to review your code and update code as needed.
6. Once reviewed and approved, a Morpheus developer will merge your pull request.

Remember, if you are unsure about anything, don't hesitate to comment on issues and ask for clarifications!

### Seasoned developers

Once you have gotten your feet wet and are more comfortable with the code, you can look at the prioritized issues for our next release in our [project boards](https://github.com/NVIDIA/Morpheus/projects).
Once you have gotten your feet wet and are more comfortable with the code, you can look at the prioritized issues for our next release in our [project boards](https://github.com/nv-morpheus/Morpheus/projects).

> **Pro Tip:** Always look at the release board with the highest number for issues to work on. This is where Morpheus developers also focus their efforts.

Expand All @@ -60,7 +60,7 @@ export PYTHON_VER=3.8
export RAPIDS_VER=22.08
export CUDA_VER=11.5
export MORPHEUS_ROOT=$(pwd)/morpheus
git clone https://github.com/NVIDIA/Morpheus.git $MORPHEUS_ROOT
git clone https://github.com/nv-morpheus/Morpheus.git $MORPHEUS_ROOT
cd $MORPHEUS_ROOT
```
The large model and data files in this repo are stored using [Git Large File Storage (LFS)](https://git-lfs.github.com/). These files will be required for running the training/validation scripts and example pipelines for the Morpheus pre-trained models.
Expand Down Expand Up @@ -168,7 +168,7 @@ Note: These instructions assume the user is using `mamba` instead of `conda` sin
export RAPIDS_VER=22.08
export CUDA_VER=11.5
export MORPHEUS_ROOT=$(pwd)/morpheus
git clone https://github.com/NVIDIA/Morpheus.git $MORPHEUS_ROOT
git clone https://github.com/nv-morpheus/Morpheus.git $MORPHEUS_ROOT
cd $MORPHEUS_ROOT
```
1. Create the morpheus Conda environment
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The following sections must be followed prior to building the Morpheus container

```bash
MORPHEUS_ROOT=$(pwd)/morpheus
git clone https://github.com/NVIDIA/Morpheus.git $MORPHEUS_ROOT
git clone https://github.com/nv-morpheus/Morpheus.git $MORPHEUS_ROOT
cd $MORPHEUS_ROOT
```

Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ def setup(app):

# The following is used by sphinx.ext.linkcode to provide links to github
linkcode_resolve = make_linkcode_resolve(
'morpheus', 'https://github.com/NVIDIA/Morpheus'
'morpheus', 'https://github.com/nv-morpheus/Morpheus'
'morpheus/-/blob/{revision}/'
'{package}/{path}#L{lineno}')

Expand Down
6 changes: 3 additions & 3 deletions docs/source/morpheus_quickstart_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -1085,9 +1085,9 @@ The Drop Null Attributes stage (dropna) requires the specification of a column n



[Morpheus Pipeline Examples]: https://github.com/NVIDIA/Morpheus/tree/branch-22.09/examples
[Morpheus Contribution]: https://github.com/NVIDIA/Morpheus/blob/branch-22.09/CONTRIBUTING.md
[Morpheus Developer Guide]: https://github.com/NVIDIA/Morpheus/tree/branch-22.09/docs/source/developer_guide/guides
[Morpheus Pipeline Examples]: https://github.com/nv-morpheus/Morpheus/tree/branch-22.09/examples
[Morpheus Contribution]: https://github.com/nv-morpheus/Morpheus/blob/branch-22.09/CONTRIBUTING.md
[Morpheus Developer Guide]: https://github.com/nv-morpheus/Morpheus/tree/branch-22.09/docs/source/developer_guide/guides
[Triton Inference Server Model Configuration]: https://github.com/triton-inference-server/server/blob/main/docs/model_configuration.md
[NVIDIA’s Cloud Native Core Stack]: https://github.com/NVIDIA/cloud-native-core
[NGC Registry CLI User Guide]: https://docs.nvidia.com/dgx/ngc-registry-cli-user-guide/index.html#topic_4_1
4 changes: 2 additions & 2 deletions models/mlflow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ mkdir -p /opt/triton_models

## Download Morpheus reference models

The Morpheus reference models can be found in the [Morpheus](https://github.com/NVIDIA/Morpheus) repo. A script is provided to fetch the models using git-lfs due to size.
The Morpheus reference models can be found in the [Morpheus](https://github.com/nv-morpheus/Morpheus) repo. A script is provided to fetch the models using git-lfs due to size.
Before running the MLflow plugin container, you can fetch the models and mount them to the local path on your host (for example, `/opt/triton_models`).

```bash
git clone https://github.com/NVIDIA/Morpheus.git morpheus
git clone https://github.com/nv-morpheus/Morpheus.git morpheus
cd morpheus
scripts/fetch_data.py fetch models
cp -RL models /opt/triton_models
Expand Down