[DOC]: Missing docstrings

[pdmack]

How would you describe the priority of this documentation request

Medium

Please provide a link or source to the relevant docs

https://docs.nvidia.com/morpheus/index.html

Describe the problems in the documentation

Casual observation and the use of interrogate reveals several areas where docstrings are missing from classes. Some of these omissions may have been intentional but they all get rendered in the HTML build regardless.

Coverage listed here: https://gist.github.com/pdmack/423e383a21d14352126c3cd993b21fb1

interrogate -vv -pPsiImM -r "name$" -r "supports_cpp_node$" --no-color --omit-covered-files morpheus

(Optional) Propose a correction

No response

Code of Conduct

• I agree to follow this project's Code of Conduct
• I have searched the open documentation issues and have found no duplicates for this bug report

[dagardner-nv]

This is a simple install with:

pip install interrogate

then running:

interrogate -vv -pPsiImM  -r "supports_cpp_node$" --omit-covered-files morpheus

Right now we have a coverage of 59.8%, looking at the output we can make a good dent in that by documenting (or making private):

• config.py: ConfigFIL
• cli/*
• messages/message_base.py
• messages/multi_ae_message.py
• messages/multi_response_message.py
• pipeline/linear_pipeline.py : LinearPipeline.increment_segment_id should be private
• pipeline/pipeline.py
• pipeline/receiver.py
• pipeline/source_stage.py
• pipeline/stream_wrapper.py : StreamWrapper.start & StreamWrapper.join
• stages/general/monitor_stage.py
• stages/inference/inference_stage.py
• stages/inference/triton_inference_stage.py
• stages/input/autoencoder_source_stage.py
• stages/input/azure_source_stage.py
• stages/input/cloud_trail_source_stage.py
• stages/input/duo_source_stage.py
• stages/input/kafka_source_stage.py
• stages/postprocess/generate_viz_frames_stage.py
• stages/postprocess/timeseries_stage.py
• utils/atomic_integer.py
• utils/click_completion_tools.py
• utils/compare_df.py
• utils/directory_watcher.py
• utils/logger.py
• utils/producer_consumer_queue.py
• utils/type_utils.py

[dagardner-nv]

@bsuryadevara is picking up the following:

 stages/general/monitor_stage.py
 stages/inference/inference_stage.py
 stages/inference/triton_inference_stage.py
 stages/input/autoencoder_source_stage.py
 stages/input/azure_source_stage.py
 stages/input/cloud_trail_source_stage.py
 stages/input/duo_source_stage.py
 stages/input/kafka_source_stage.py
 stages/postprocess/generate_viz_frames_stage.py
 stages/postprocess/timeseries_stage.py