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 docs for clarity #927

Merged
merged 11 commits into from
Sep 3, 2024
Merged

Updated docs for clarity #927

merged 11 commits into from
Sep 3, 2024

Conversation

Linardos
Copy link
Contributor

Proposed Changes

  • in_memory explanation added
  • cleaned up setup.md a bit

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].
  • The logging library is being used and no print statements are left.

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

github-actions bot commented Aug 31, 2024

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

@Linardos Linardos changed the title updated docs - in_memory explanation, some changes in updated docs Aug 31, 2024
docs/customize.md Outdated Show resolved Hide resolved
docs/customize.md Outdated Show resolved Hide resolved
docs/setup.md Outdated Show resolved Hide resolved
docs/setup.md Outdated Show resolved Hide resolved
docs/setup.md Outdated Show resolved Hide resolved
Linardos and others added 4 commits September 1, 2024 17:58
Co-authored-by: Sarthak Pati <[email protected]>
Co-authored-by: Sarthak Pati <[email protected]>
Co-authored-by: Sarthak Pati <[email protected]>
Co-authored-by: Sarthak Pati <[email protected]>
@Linardos Linardos changed the title updated docs Updated docs for clarity Sep 1, 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 updates

docs/setup.md Outdated Show resolved Hide resolved
docs/setup.md Outdated Show resolved Hide resolved
docs/setup.md Outdated Show resolved Hide resolved
docs/setup.md Outdated Show resolved Hide resolved
docs/setup.md Outdated Show resolved Hide resolved
docs/setup.md Outdated Show resolved Hide resolved
docs/setup.md Outdated Show resolved Hide resolved
docs/setup.md Outdated Show resolved Hide resolved
@sarthakpati sarthakpati merged commit 3c52a99 into mlcommons:master Sep 3, 2024
19 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Sep 3, 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