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
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
64 commits
Select commit Hold shift + click to select a range
8862c76
Set docstrings
dagardner-nv Jan 23, 2023
ec447d0
add docstrings
dagardner-nv Jan 23, 2023
9b39443
add docstrings, and make other methods private
dagardner-nv Jan 23, 2023
a94783c
Add docstrings
dagardner-nv Jan 23, 2023
c899729
Add interrogate
dagardner-nv Jan 23, 2023
b5d9f50
Ignore cli from interrogate
dagardner-nv Jan 23, 2023
806683f
Revert "add docstrings, and make other methods private"
dagardner-nv Jan 23, 2023
4ab1779
Revert "Add docstrings"
dagardner-nv Jan 23, 2023
804f2d3
More docstrings
dagardner-nv Jan 23, 2023
4df1f02
Docstrings for messages
dagardner-nv Jan 24, 2023
8eb63db
More docstrings
dagardner-nv Jan 24, 2023
882c37f
More docstrings
dagardner-nv Jan 24, 2023
6de6fcb
More docstrings
dagardner-nv Jan 24, 2023
862f7f4
More docstrings
dagardner-nv Jan 24, 2023
2359553
Remove unreachable code
dagardner-nv Jan 24, 2023
ca19f77
Add docstrings, remove unused mirror_args method
dagardner-nv Jan 24, 2023
740ddf1
Ignore the empty typing overloads
dagardner-nv Jan 24, 2023
e6c8e31
more docstrings
dagardner-nv Jan 24, 2023
b1138aa
Add docstring
dagardner-nv Jan 24, 2023
a19e47a
Add docstrings
dagardner-nv Jan 24, 2023
51a33d7
Move click_completion_tools to cli
dagardner-nv Jan 24, 2023
c274aa2
added missing docs
bsuryadevara Jan 24, 2023
e09ed76
Remove duplicate morpheus.utils.logger.get_log_levels and morpheus.ut…
dagardner-nv Jan 24, 2023
5cff868
increment_segment_id should be considered a private method
dagardner-nv Jan 24, 2023
da40744
Merge branch 'david-missing-docstrings-549' of https://github.com/dag…
bsuryadevara Jan 24, 2023
1b3fde1
Fix sorting of imports
dagardner-nv Jan 24, 2023
1c3ad0d
Rename private methods, prefixing a '_'
dagardner-nv Jan 24, 2023
9c09a90
Fix import ordering
dagardner-nv Jan 24, 2023
4f5f7b4
Add docstrings to existing methods
dagardner-nv Jan 24, 2023
bb9909b
Add a docstring to get_input_pair
dagardner-nv Jan 24, 2023
3ffe2aa
Remove unused/uncalled start method, document the join method
dagardner-nv Jan 24, 2023
624c063
Remove unused import
dagardner-nv Jan 24, 2023
53bb756
added missing docs
bsuryadevara Jan 24, 2023
ede91a8
Merge branch 'branch-23.01' into david-missing-docstrings-549
dagardner-nv Jan 24, 2023
1a5f7e9
Merge branch 'david-missing-docstrings-549' of github.com:dagardner-n…
dagardner-nv Jan 24, 2023
dc7cd7c
Ignore nested functions
dagardner-nv Jan 24, 2023
055fecd
wip
dagardner-nv Jan 24, 2023
b41b808
added missing docs
bsuryadevara Jan 24, 2023
a302aa8
Merge branch 'david-missing-docstrings-549' of https://github.com/dag…
bsuryadevara Jan 24, 2023
0a2d226
added missing docs
bsuryadevara Jan 24, 2023
1e2b522
docstrings for column_info
dagardner-nv Jan 24, 2023
bee3282
Merge branch 'david-missing-docstrings-549' of github.com:dagardner-n…
dagardner-nv Jan 24, 2023
4464605
More docstrings!
dagardner-nv Jan 24, 2023
8f99c1a
Revert changes to docs/requirements.txt
dagardner-nv Jan 24, 2023
d4e9907
We shouldn't need to rename nested functions interrogate has a config…
dagardner-nv Jan 24, 2023
b26e5e1
Merge branch 'branch-23.01' into david-missing-docstrings-549
dagardner-nv Jan 24, 2023
a18b65d
Docstrings for new fields
dagardner-nv Jan 24, 2023
b2dcef7
Capitalize FIL
dagardner-nv Jan 25, 2023
de8c633
Rename do_run to run_async per feedback from mdd
dagardner-nv Jan 25, 2023
90edc80
Add missing validation_size arg to DFPTraining constructor - unrelate…
dagardner-nv Jan 25, 2023
3ee9393
Merge branch 'branch-23.01' into david-missing-docstrings-549
dagardner-nv Jan 25, 2023
89624d1
Update morpheus/messages/multi_ae_message.py
dagardner-nv Jan 26, 2023
86f1b60
Update morpheus/stages/inference/triton_inference_stage.py
dagardner-nv Jan 26, 2023
26169dc
Update morpheus/stages/inference/triton_inference_stage.py
dagardner-nv Jan 26, 2023
64ab121
Update morpheus/stages/postprocess/timeseries_stage.py
dagardner-nv Jan 26, 2023
1b90082
Addressing PR feedback
dagardner-nv Jan 26, 2023
49f6dc2
Make TimeSeriesAction and UserTimeSeries private
dagardner-nv Jan 26, 2023
9ece5aa
Merge branch 'david-missing-docstrings-549' of github.com:dagardner-n…
dagardner-nv Jan 26, 2023
bf883a6
Expand the and
dagardner-nv Jan 26, 2023
8ac68e2
Break up long line
dagardner-nv Jan 26, 2023
ac2f0a4
Lazily load click_completion_tools
dagardner-nv Jan 26, 2023
665d41c
Merge branch 'branch-23.01' into david-missing-docstrings-549
dagardner-nv Jan 26, 2023
962f5e6
Finish sentence in docstring
dagardner-nv Jan 26, 2023
72df53c
Revert "Remove unreachable code"
dagardner-nv Jan 26, 2023
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
Remove duplicate morpheus.utils.logger.get_log_levels and morpheus.ut…
…ils.logger.parse_log_level which also exist in morpheus.cli.utils
  • Loading branch information
dagardner-nv committed Jan 24, 2023
commit e09ed76f1819a8e26dde84e3542b69d08cb7b26d
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@
"from morpheus.stages.postprocess.filter_detections_stage import FilterDetectionsStage\n",
"from morpheus.stages.postprocess.serialize_stage import SerializeStage\n",
"from morpheus.utils.logger import configure_logging\n",
"from morpheus.utils.logger import get_log_levels\n",
"from morpheus.utils.logger import parse_log_level\n",
"from morpheus.cli.utils import get_log_levels\n",
"from morpheus.cli.utils import parse_log_level\n",
"\n",
"# Left align all tables\n",
"from IPython.core.display import HTML\n",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@
from morpheus.stages.postprocess.filter_detections_stage import FilterDetectionsStage
from morpheus.stages.postprocess.serialize_stage import SerializeStage
from morpheus.utils.logger import configure_logging
from morpheus.utils.logger import get_log_levels
from morpheus.utils.logger import parse_log_level
from morpheus.cli.utils import get_log_levels
from morpheus.cli.utils import parse_log_level


@click.command()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@
"from morpheus.stages.general.monitor_stage import MonitorStage\n",
"from morpheus.stages.output.write_to_file_stage import WriteToFileStage\n",
"from morpheus.utils.logger import configure_logging\n",
"from morpheus.utils.logger import get_log_levels\n",
"from morpheus.utils.logger import parse_log_level\n",
"from morpheus.cli.utils import get_log_levels\n",
"from morpheus.cli.utils import parse_log_level\n",
"\n",
"# Left align all tables\n",
"from IPython.core.display import HTML\n",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@
"from morpheus.stages.postprocess.filter_detections_stage import FilterDetectionsStage\n",
"from morpheus.stages.postprocess.serialize_stage import SerializeStage\n",
"from morpheus.utils.logger import configure_logging\n",
"from morpheus.utils.logger import get_log_levels\n",
"from morpheus.utils.logger import parse_log_level\n",
"from morpheus.cli.utils import get_log_levels\n",
"from morpheus.cli.utils import parse_log_level\n",
"\n",
"# Left align all tables\n",
"from IPython.core.display import HTML\n",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@
from morpheus.stages.postprocess.filter_detections_stage import FilterDetectionsStage
from morpheus.stages.postprocess.serialize_stage import SerializeStage
from morpheus.utils.logger import configure_logging
from morpheus.utils.logger import get_log_levels
from morpheus.utils.logger import parse_log_level
from morpheus.cli.utils import get_log_levels
from morpheus.cli.utils import parse_log_level


@click.command()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@
"from morpheus.stages.general.monitor_stage import MonitorStage\n",
"from morpheus.stages.output.write_to_file_stage import WriteToFileStage\n",
"from morpheus.utils.logger import configure_logging\n",
"from morpheus.utils.logger import get_log_levels\n",
"from morpheus.utils.logger import parse_log_level\n",
"from morpheus.cli.utils import get_log_levels\n",
"from morpheus.cli.utils import parse_log_level\n",
"\n",
"# Left align all tables\n",
"from IPython.core.display import HTML\n",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@
from morpheus.pipeline import LinearPipeline
from morpheus.stages.general.monitor_stage import MonitorStage
from morpheus.utils.logger import configure_logging
from morpheus.utils.logger import get_log_levels
from morpheus.utils.logger import parse_log_level
from morpheus.cli.utils import get_log_levels
from morpheus.cli.utils import parse_log_level


@click.command()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@
from morpheus.pipeline import LinearPipeline
from morpheus.stages.general.monitor_stage import MonitorStage
from morpheus.utils.logger import configure_logging
from morpheus.utils.logger import get_log_levels
from morpheus.utils.logger import parse_log_level
from morpheus.cli.utils import get_log_levels
from morpheus.cli.utils import parse_log_level


@click.command()
Expand Down
26 changes: 0 additions & 26 deletions morpheus/utils/logger.py
Original file line number Diff line number Diff line change
Expand Up @@ -218,29 +218,3 @@ def deprecated_stage_warning(logger, cls, name):
"It has no effect and acts as a pass through stage."),
cls.__name__,
name)


def get_log_levels():
"""
Return a list of the available log levels as strings in order from CRITICAL --> DEBUG

Returns
-------
typing.List[str]
"""
log_levels = list(logging._nameToLevel.keys())

if ("NOTSET" in log_levels):
log_levels.remove("NOTSET")

return log_levels


def parse_log_level(ctx, param, value):
"""
Given a log-level name return the numeric log level value used by the Python logger.
"""
x = logging._nameToLevel.get(value.upper(), None)
if x is None:
raise click.BadParameter('Must be one of {}. Passed: {}'.format(", ".join(logging._nameToLevel.keys()), value))
return x