akoumpa commented 6 days ago

What does this PR do ?

Hf -> HF

Since io.IOMixin, fn.FNMixin exist (three capital letter in a row).

Collection: [Note which collection this PR will affect]

Changelog

Add specific line by line info of high level changes in this PR.

Usage

You can potentially add a usage example below

# Add a code snippet demonstrating how to use this

GitHub Actions CI

The Jenkins CI system has been replaced by GitHub Actions self-hosted runners.

The GitHub Actions CI will run automatically when the "Run CICD" label is added to the PR. To re-run CI remove and add the label again. To run CI on an untrusted fork, a NeMo user with write access must first click "Approve and run".

Before your PR is "Ready for review"

Pre checks:

[ ] Make sure you read and followed Contributor guidelines
[ ] Did you write any new necessary tests?
[ ] Did you add or update any necessary documentation?
[ ] Does the PR affect components that are optional to install? (Ex: Numba, Pynini, Apex etc)
- [ ] Reviewer: Does the PR have correct import guards for all optional libraries?

PR Type:

[ ] New Feature
[ ] Bugfix
[ ] Documentation

If you haven't finished some of the above items you can still open "Draft" PR.

Who can review?

Anyone in the community is free to review the PR once the checks have passed. Contributor guidelines contains specific people who can review PRs to various areas.

Additional Information

Related to # (issue)

github-actions[bot] commented 3 days ago

beep boop 🤖: 🙏 The following files have warnings. In case you are familiar with these, please try helping us to improve the code base.

Your code was analyzed with PyLint. The following annotations have been identified:

************* Module hf
examples/llm/peft/hf.py:25:0: C0301: Line too long (184/119) (line-too-long)
examples/llm/peft/hf.py:76:0: C0301: Line too long (162/119) (line-too-long)
examples/llm/peft/hf.py:21:0: C0116: Missing function or method docstring (missing-function-docstring)
examples/llm/sft/hf.py:74:0: C0301: Line too long (162/119) (line-too-long)
examples/llm/sft/hf.py:26:0: C0115: Missing class docstring (missing-class-docstring)
examples/llm/sft/hf.py:39:0: C0116: Missing function or method docstring (missing-function-docstring)
examples/llm/sft/hf.py:23:0: W0611: Unused ModelCallback imported from nemo.lightning.pytorch.callbacks (unused-import)
************* Module nemo.collections.llm.gpt.data.api
nemo/collections/llm/gpt/data/api.py:26:0: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/llm/gpt/data/api.py:32:0: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/llm/gpt/data/api.py:38:0: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/llm/gpt/data/api.py:44:0: C0116: Missing function or method docstring (missing-function-docstring)
************* Module nemo.collections.llm.gpt.data.hf_dataset
nemo/collections/llm/gpt/data/hf_dataset.py:21:0: C0115: Missing class docstring (missing-class-docstring)
nemo/collections/llm/gpt/data/hf_dataset.py:51:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/llm/gpt/data/hf_dataset.py:77:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/llm/gpt/data/hf_dataset.py:87:4: C0116: Missing function or method docstring (missing-function-docstring)
************* Module nemo.collections.llm.gpt.model.hf_auto_model_for_causal_lm
nemo/collections/llm/gpt/model/hf_auto_model_for_causal_lm.py:26:0: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/llm/gpt/model/hf_auto_model_for_causal_lm.py:34:0: C0115: Missing class docstring (missing-class-docstring)
nemo/collections/llm/gpt/model/hf_auto_model_for_causal_lm.py:58:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/llm/gpt/model/hf_auto_model_for_causal_lm.py:69:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/llm/gpt/model/hf_auto_model_for_causal_lm.py:72:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/llm/gpt/model/hf_auto_model_for_causal_lm.py:89:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/llm/gpt/model/hf_auto_model_for_causal_lm.py:101:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/llm/gpt/model/hf_auto_model_for_causal_lm.py:115:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/llm/gpt/model/hf_auto_model_for_causal_lm.py:126:4: C0116: Missing function or method docstring (missing-function-docstring)
************* Module nemo.collections.llm.recipes.hf_auto_model_for_causal_lm
nemo/collections/llm/recipes/hf_auto_model_for_causal_lm.py:103:0: C0301: Line too long (162/119) (line-too-long)
nemo/collections/llm/recipes/hf_auto_model_for_causal_lm.py:154:0: C0301: Line too long (126/119) (line-too-long)
nemo/collections/llm/recipes/hf_auto_model_for_causal_lm.py:193:0: C0301: Line too long (121/119) (line-too-long)

-----------------------------------
Your code has been rated at 9.61/10

Thank you for improving NeMo's documentation!

github-actions[bot] commented 3 days ago

[🤖]: Hi @akoumpa 👋,

We wanted to let you know that a CICD pipeline for this PR just finished successfully

So it might be time to merge this PR or get some approvals

I'm just a bot so I'll leave it you what to do next.

//cc @pablo-garay @ko3n1g

akoumpa commented 3 days ago

@oyilmaz-nvidia FYI

NVIDIA / NeMo

capitalize HF as HF instead of Hf #11384