Added the ability to perform automated spell checking

[szmazurek]

Fixes #ISSUE_NUMBER

Proposed Changes

• added CI for spellchecker

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.

[github-actions]

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

[github-advanced-security]

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

[szmazurek]

@sarthakpati check the output of the spellchecker action, this will probably need some more customization, I also have no idea why it complains about yaml extension

[sarthakpati]

Add a new file called .spelling to the repo with the following:

words:
  - yml
  - yaml
  - gandlf
  - GaNDLF

Update the action to use this file:

# previous steps go here
      - name: Spellcheck
        uses: check-spelling/check-spelling@main
        with:
          config: .spelling ## this is needed

[codecov]

Codecov Report

Attention: Patch coverage is 80.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 91.99%. Comparing base (966f84f) to head (60eda6c).

Files with missing lines	Patch %	Lines
GANDLF/cli/huggingface_hub_handler.py	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #941      +/-   ##
==========================================
- Coverage   92.00%   91.99%   -0.02%     
==========================================
  Files         171      171              
  Lines       10006    10006              
==========================================
- Hits         9206     9205       -1     
- Misses        800      801       +1     

Flag	Coverage Δ
unittests	91.99% <80.00%> (-0.02%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

---

🚨 Try these New Features:

• Flaky Tests Detection - Detect and resolve failed and flaky tests

[sarthakpati]

@szmazurek it seems like the CI is working, no? Can you please take a look and fix the misspelt words so that we can merge?

[sarthakpati]

Hey @szmazurek is this good to merge?

[sarthakpati]

Waiting for this to merged before tagging.