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

Updated GaNDLF documentation for clarity #915

Merged
merged 5 commits into from
Aug 16, 2024

Conversation

Linardos
Copy link
Contributor

@Linardos Linardos commented Aug 14, 2024

Proposed Changes

  • The changes are only on the documentation. Added an early explanation of config files and emphasized GaNDLF's purpose, plus added some edits further on for clarity and flow and to attract user's eye to the most important information.

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].

@Linardos Linardos requested a review from a team as a code owner August 14, 2024 01:22
Copy link
Contributor

github-actions bot commented Aug 14, 2024

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

@Linardos Linardos changed the title added early explanation of GaNDLF's purpose and utility plus edits further on Updated GaNDLF documentation for clarity Aug 14, 2024
@sarthakpati
Copy link
Collaborator

Hey @Linardos, thank you for your contribution!

Please sign the CLA and we then can merge this PR.

@sarthakpati sarthakpati merged commit 0635d8b into mlcommons:master Aug 16, 2024
19 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Aug 16, 2024
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