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 log file parameter to cli commands #912

Merged

Conversation

benmalef
Copy link
Contributor

@benmalef benmalef commented Aug 5, 2024

Proposed Changes

  • Update the cli commands, adding --log-file parameter.
  • Update the docs.extending

Screenshots

If the user doesn't use the --log-file par, the logs will be saved in the /tmp/.gandlf dir
image

If the user uses the --log-file parameter.
image

Checklist

  • CONTRIBUTING guide has been followed.
  • PR is based on the current GaNDLF master .
  • Non-breaking change (does not break existing functionality): provide as many details as possible for any breaking change.
  • Function/class source code documentation added/updated (ensure typing is used to provide type hints, including and not limited to using Optional if a variable has a pre-defined value).
  • Code has been blacked for style consistency and linting.
  • If applicable, version information has been updated in GANDLF/version.py.
  • If adding a git submodule, add to list of exceptions for black styling in pyproject.toml file.
  • Usage documentation has been updated, if appropriate.
  • Tests added or modified to cover the changes; if coverage is reduced, please give explanation.
  • If customized dependency installation is required (i.e., a separate pip install step is needed for PR to be functional), please ensure it is reflected in all the files that control the CI, namely: python-test.yml, and all docker files [1,2,3].

Copy link
Contributor

github-actions bot commented Aug 5, 2024

MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅

@benmalef benmalef changed the title Add --log-file parameter to cli commands Add log-file parameter to cli commands Aug 5, 2024
@benmalef benmalef changed the title Add log-file parameter to cli commands Add log file parameter to cli commands Aug 5, 2024
Copy link
Collaborator

@sarthakpati sarthakpati left a comment

Choose a reason for hiding this comment

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

Minor change requested. Also, I would suggest to add another point in the PR template:

- [ ] The `logging` library is being used and no `print` statements are left.

docs/extending.md Outdated Show resolved Hide resolved
@benmalef benmalef marked this pull request as ready for review August 14, 2024 20:45
@benmalef benmalef requested a review from a team as a code owner August 14, 2024 20:45
@sarthakpati sarthakpati merged commit 41a0705 into mlcommons:master Aug 20, 2024
19 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Aug 20, 2024
@benmalef benmalef deleted the add_logging_parameter_to_CLI_commands branch September 13, 2024 06:27
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants