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
Merge branch 'branch-23.01' into david-23.01-docs
  • Loading branch information
dagardner-nv committed Dec 6, 2022
commit 530b40efef9e6d9a0b0df0e761a755b88c1f36f2
4 changes: 2 additions & 2 deletions examples/abp_nvsmi_detection/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ $ nvidia-smi dmon
0 281 57 - 85 54 0 0 7000 1740
```

Each line in the output represents the GPU metrics at a single point in time. As the tool progresses the GPU begins to be utilized and the SM% and Mem% values increase as memory is loaded into the GPU and computations are performed. The model we will be using can ingest this information and determine whether or not the GPU is mining cryptocurriences without needing additional information from the host machine.
Each line in the output represents the GPU metrics at a single point in time. As the tool progresses the GPU begins to be utilized and the SM% and Mem% values increase as memory is loaded into the GPU and computations are performed. The model we will be using can ingest this information and determine whether or not the GPU is mining cryptocurrencies without needing additional information from the host machine.

In this example we will be using the `examples/data/nvsmi.jsonlines` dataset that is known to contain mining behavior profiles. The dataset is in the `.jsonlines` format which means each new line represents a new JSON object. In order to parse this data, it must be ingested, split by lines into individual JSON objects, and parsed into cuDF dataframes. This will all be handled by Morpheus.

Expand Down Expand Up @@ -221,4 +221,4 @@ The output file `detections.jsonlines` will contain a single boolean value for e
...
```

We have stripped out the input data to make the detections easier to identify. Ommitting the argument `--include 'mining'` would show the input data in the detections file.
We have stripped out the input data to make the detections easier to identify. Omitting the argument `--include 'mining'` would show the input data in the detections file.
3 changes: 1 addition & 2 deletions examples/root_cause_analysis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,6 @@ Configuring Pipeline via CLI
Loaded labels file. Current labels: [['not_root_cause', 'is_root_cause']]
Parameter, 'vocab_hash_file', with relative path, './data/bert-base-uncased-hash.txt', does not exist. Using package relative location: '/opt/conda/envs/morpheus/lib/python3.8/site-packages/morpheus/./data/bert-base-uncased-hash.txt'
Starting pipeline via CLI... Ctrl+C to Quit
W20221115 18:41:05.942132 31192 thread.cpp:138] unable to set memory policy - if using docker use: --cap-add=sys_nice to allow membind
Config:
{
"ae": null,
Expand Down Expand Up @@ -160,7 +159,7 @@ Starting! Time: 1668537665.9479523
====Registering Pipeline Complete!====
====Starting Pipeline====
====Pipeline Started====
Added source: <from-file-0; FileSourceStage(filename=/my_data/gitrepos/efajardo-nv/Morpheus/models/datasets/validation-data/root-cause-validation-data-input.jsonlines, iterative=False, file_type=FileTypes.Auto, repeat=1, filter_null=True, cudf_kwargs=None)>
Added source: <from-file-0; FileSourceStage(filename=/workspace/models/datasets/validation-data/root-cause-validation-data-input.jsonlines, iterative=False, file_type=FileTypes.Auto, repeat=1, filter_null=True, cudf_kwargs=None)>
└─> morpheus.MessageMeta
Added stage: <deserialize-1; DeserializeStage()>
└─ morpheus.MessageMeta -> morpheus.MultiMessage
Expand Down
You are viewing a condensed version of this merge commit. You can view the full changes here.