Initial commit
State: closed | Pull request: yes
Labels: name: stale

# What does this PR do ?

Add a one line overview of what this PR aims to accomplish.

**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

```python
# 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](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**:
- [ ] 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)


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

beep boop 🤖: 🚨 The following files must be fixed before merge!

---

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

```
************* Module nemo.collections.vlm.clip.data.mock
nemo/collections/vlm/clip/data/mock.py:29:0: C0115: Missing class docstring (missing-class-docstring)
nemo/collections/vlm/clip/data/mock.py:74:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/data/mock.py:85:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/data/mock.py:90:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/data/mock.py:95:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/data/mock.py:24:0: W0611: Unused IMAGE_TOKEN_INDEX imported from nemo.collections.vlm.neva.data.multimodal_tokens (unused-import)
************* Module nemo.collections.vlm.clip.loss.clip_loss
nemo/collections/vlm/clip/loss/clip_loss.py:170:0: C0301: Line too long (124/119) (line-too-long)
nemo/collections/vlm/clip/loss/clip_loss.py:3:0: W0611: Unused Sequence imported from typing (unused-import)
nemo/collections/vlm/clip/loss/clip_loss.py:20:0: W0611: Unused torch.nn imported as nn (unused-import)
nemo/collections/vlm/clip/loss/clip_loss.py:26:0: W0611: Unused ReductionT imported from nemo.lightning.megatron_parallel (unused-import)
************* Module nemo.collections.vlm.clip.model.base
nemo/collections/vlm/clip/model/base.py:27:0: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/model/base.py:32:0: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/model/base.py:37:0: C0115: Missing class docstring (missing-class-docstring)
nemo/collections/vlm/clip/model/base.py:55:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/model/base.py:78:0: C0115: Missing class docstring (missing-class-docstring)
nemo/collections/vlm/clip/model/base.py:122:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/model/base.py:125:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/model/base.py:136:0: C0115: Missing class docstring (missing-class-docstring)
nemo/collections/vlm/clip/model/base.py:150:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/model/base.py:178:0: C0115: Missing class docstring (missing-class-docstring)
nemo/collections/vlm/clip/model/base.py:221:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/model/base.py:228:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/model/base.py:233:0: C0115: Missing class docstring (missing-class-docstring)
nemo/collections/vlm/clip/model/base.py:244:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/model/base.py:254:0: C0115: Missing class docstring (missing-class-docstring)
nemo/collections/vlm/clip/model/base.py:271:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/model/base.py:279:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/model/base.py:283:0: C0115: Missing class docstring (missing-class-docstring)
nemo/collections/vlm/clip/model/base.py:302:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/model/base.py:306:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/model/base.py:309:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/model/base.py:322:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/model/base.py:325:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/model/base.py:329:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/model/base.py:335:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/model/base.py:342:4: C0116: Missing function or method docstring (missing-function-docstring)
************* Module nemo.collections.vlm.clip.model.clip
nemo/collections/vlm/clip/model/clip.py:114:0: C0301: Line too long (137/119) (line-too-long)
nemo/collections/vlm/clip/model/clip.py:115:0: C0301: Line too long (133/119) (line-too-long)
nemo/collections/vlm/clip/model/clip.py:116:0: C0301: Line too long (140/119) (line-too-long)
nemo/collections/vlm/clip/model/clip.py:117:0: C0301: Line too long (136/119) (line-too-long)
nemo/collections/vlm/clip/model/clip.py:122:0: C0301: Line too long (129/119) (line-too-long)
nemo/collections/vlm/clip/model/clip.py:123:0: C0301: Line too long (125/119) (line-too-long)
nemo/collections/vlm/clip/model/clip.py:124:0: C0301: Line too long (141/119) (line-too-long)
nemo/collections/vlm/clip/model/clip.py:125:0: C0301: Line too long (137/119) (line-too-long)
nemo/collections/vlm/clip/model/clip.py:126:0: C0301: Line too long (144/119) (line-too-long)
nemo/collections/vlm/clip/model/clip.py:127:0: C0301: Line too long (140/119) (line-too-long)
nemo/collections/vlm/clip/model/clip.py:132:0: C0301: Line too long (133/119) (line-too-long)
nemo/collections/vlm/clip/model/clip.py:133:0: C0301: Line too long (129/119) (line-too-long)
nemo/collections/vlm/clip/model/clip.py:43:0: C0115: Missing class docstring (missing-class-docstring)
nemo/collections/vlm/clip/model/clip.py:65:0: C0115: Missing class docstring (missing-class-docstring)
nemo/collections/vlm/clip/model/clip.py:71:0: C0115: Missing class docstring (missing-class-docstring)
nemo/collections/vlm/clip/model/clip.py:93:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/model/clip.py:151:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/model/clip.py:157:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/vlm/clip/model/clip.py:282:0: C0116: Missing function or method docstring (missing-function-docstring)

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

---

Mitigation guide:

* Add sensible and useful docstrings to functions and methods
* For trivial methods like getter/setters, consider adding `# pylint: disable=C0116` inside the function itself
* To disable multiple functions/methods at once, put a `# pylint: disable=C0116` before the first and a `# pylint: enable=C0116` after the last.

By applying these rules, we reduce the occurance of this message in future.

Thank you for improving NeMo's documentation!

This PR is stale because it has been open for 14 days with no activity. Remove stale label or comment or update or this will be closed in 7 days.

This PR was closed because it has been inactive for 7 days since being marked as stale.