Profiling - support Chakra & Kineto trace dumping
State: closed | Pull request: yes
Labels: name: core

name: Run CICD

# What does this PR do ?

**Add support of Chakra trace & Kineto trace dumping by `torch.profiler.profile`,  take nsys profiling as PR reference**

**Collection**: [Note which collection this PR will affect] **All collections which is based on modelPT**

# Changelog 
- Add specific line by line info of high level changes in this PR.
modePT.py:1747  Add setup chakra profiling
modePT.py:1917  Start chakra profiling at batch start callback
modePT.py:1917  End chakra profiling at batch end callback

# Usage
* You can potentially add a usage example below
NeMo-Framework-Launcher
```python
# Add a code snippet demonstrating how to use this 
python3 ${NEMO_FRAMEWORK_LAUNCHER_DIR}/launcher_scripts/main.py \
training=gpt3/5b \
...
training.trainer.num_nodes=2 \
+training.model.optim.grad_sync_dtype=bf16 \
+training.model.chakra_profile.enabled=True \
+training.model.chakra_profile.start_step=0 \
+training.model.chakra_profile.end_step=10 \
+training.model.chakra_profile.warmup_steps=0 \
+training.model.chakra_profile.active_steps=1 \
+training.model.chakra_profile.trace_dir=${NEMO_FRAMEWORK_LAUNCHER_DIR}results/chakra/ \
```

# 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**:
- [x] Make sure you read and followed [Contributor guidelines](https://github.com/NVIDIA/NeMo/blob/main/CONTRIBUTING.md)
- [ ] 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**:
- [x] 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](https://github.com/NVIDIA/NeMo/blob/main/CONTRIBUTING.md) contains specific people who can review PRs to various areas.

# Additional Information
* Related to # (issue)


Hi @maanug-nv , I have fixed all the comments, can you help to review it again? I did `python setup.py style --fix` locally, and it returns successfully, but the reformat job seems failed, looks like it's a flow issue, I think it looks ready to be merged in.

Hi @maanug-nv , I updated the branch since it's out of date, seems only maintainers could edit the label? wondering if you could help to re-run the CICD? thanks

<!-- pylint-output-strict-mode-false -->

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 nemo.core.classes.modelPT
nemo/core/classes/modelPT.py:82:0: C0301: Line too long (130/119) (line-too-long)
nemo/core/classes/modelPT.py:177:0: C0301: Line too long (121/119) (line-too-long)
nemo/core/classes/modelPT.py:184:0: C0301: Line too long (154/119) (line-too-long)
nemo/core/classes/modelPT.py:258:0: C0301: Line too long (131/119) (line-too-long)
nemo/core/classes/modelPT.py:262:0: C0301: Line too long (132/119) (line-too-long)
nemo/core/classes/modelPT.py:310:0: C0301: Line too long (160/119) (line-too-long)
nemo/core/classes/modelPT.py:390:0: C0301: Line too long (135/119) (line-too-long)
nemo/core/classes/modelPT.py:1232:0: C0301: Line too long (123/119) (line-too-long)
nemo/core/classes/modelPT.py:1469:0: C0301: Line too long (140/119) (line-too-long)
nemo/core/classes/modelPT.py:1680:0: C0301: Line too long (128/119) (line-too-long)
nemo/core/classes/modelPT.py:1699:0: C0301: Line too long (135/119) (line-too-long)
nemo/core/classes/modelPT.py:1709:0: C0301: Line too long (122/119) (line-too-long)
nemo/core/classes/modelPT.py:1835:0: C0301: Line too long (166/119) (line-too-long)
nemo/core/classes/modelPT.py:1904:0: C0301: Line too long (120/119) (line-too-long)
nemo/core/classes/modelPT.py:2058:0: C0301: Line too long (151/119) (line-too-long)
nemo/core/classes/modelPT.py:223:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/core/classes/modelPT.py:869:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/core/classes/modelPT.py:926:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/core/classes/modelPT.py:930:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/core/classes/modelPT.py:937:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/core/classes/modelPT.py:1205:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/core/classes/modelPT.py:1629:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/core/classes/modelPT.py:1747:4: C0116: Missing function or method docstring (missing-function-docstring)

-----------------------------------
Your code has been rated at 9.71/10
```

---

Thank you for improving NeMo's documentation!