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

Add missing docstrings #628

Merged
64 commits merged into from
Jan 26, 2023

Conversation

dagardner-nv
Copy link
Contributor

@dagardner-nv dagardner-nv commented Jan 24, 2023

  • Adds docstrings to several public API classes & functions fixes [DOC]: Missing docstrings #549
  • Remove unreachable custreamz code in Receiver
  • Exclude morpheus/cli from coverage scans
  • Unrelated fix for DFP notebooks missing validation_size constructor arg

Breaking changes:

  • Pipeline._do_run is now Pipeline.run_async
  • Remove StreamWrapper.start this method wasn't being used, and wasn't being called.
  • Some methods were marked as "private" by prepending a _ to the name
  • click_completion_tools moved from morpheus/utils to morpheus/cli
  • Remove unused morpheus.utils.type_utils.mirror_args method
  • Remove duplicate get_log_levels & parse_log_level methods from morpheus.utils.logger which also exist in morpheus.cli.utils fixes [BUG]: Duplicate methods in utils/logger.py #624

TODO:

  • Build sphinx make sure new docs all look good
  • Test/verify changes in DFP
  • Test/verify changes in visualization

@dagardner-nv dagardner-nv added breaking Breaking change doc Improvements or additions to documentation 2 - In Progress labels Jan 24, 2023
@dagardner-nv dagardner-nv requested review from a team as code owners January 24, 2023 17:37
docs/requirements.txt Outdated Show resolved Hide resolved
bsuryadevara and others added 2 commits January 24, 2023 11:47
…ils.logger.parse_log_level which also exist in morpheus.cli.utils
Copy link
Contributor

@mdemoret-nv mdemoret-nv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good once the comments are addressed.

morpheus/cli/commands.py Outdated Show resolved Hide resolved
morpheus/messages/multi_ae_message.py Outdated Show resolved Hide resolved
morpheus/pipeline/pipeline.py Outdated Show resolved Hide resolved
morpheus/pipeline/pipeline.py Outdated Show resolved Hide resolved
morpheus/pipeline/pipeline.py Outdated Show resolved Hide resolved
morpheus/stages/inference/triton_inference_stage.py Outdated Show resolved Hide resolved
morpheus/stages/inference/triton_inference_stage.py Outdated Show resolved Hide resolved
morpheus/stages/postprocess/timeseries_stage.py Outdated Show resolved Hide resolved
morpheus/stages/postprocess/timeseries_stage.py Outdated Show resolved Hide resolved
morpheus/stages/postprocess/timeseries_stage.py Outdated Show resolved Hide resolved
dagardner-nv and others added 8 commits January 26, 2023 12:14
Co-authored-by: Michael Demoret <42954918+mdemoret-nv@users.noreply.github.com>
Co-authored-by: Michael Demoret <42954918+mdemoret-nv@users.noreply.github.com>
Co-authored-by: Michael Demoret <42954918+mdemoret-nv@users.noreply.github.com>
Co-authored-by: Michael Demoret <42954918+mdemoret-nv@users.noreply.github.com>
…v/Morpheus into david-missing-docstrings-549
@dagardner-nv
Copy link
Contributor Author

/merge

@ghost ghost merged commit b8d3d46 into nv-morpheus:branch-23.01 Jan 26, 2023
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking Breaking change doc Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

[BUG]: Duplicate methods in utils/logger.py [DOC]: Missing docstrings
4 participants