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

docs and simplification of cmd args #8979

Merged
merged 13 commits into from
Apr 29, 2024
Merged

Conversation

arendu
Copy link
Collaborator

@arendu arendu commented Apr 19, 2024

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
# Add a code snippet demonstrating how to use this 

Jenkins CI

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

There's no need to comment jenkins on the PR to trigger Jenkins CI.
The GitHub Actions CI will run automatically when the PR is opened.
To run CI on an untrusted fork, a NeMo user with write access must 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)

@arendu arendu requested a review from JRD971000 April 19, 2024 05:26
@github-actions github-actions bot added the NLP label Apr 19, 2024
@arendu
Copy link
Collaborator Author

arendu commented Apr 19, 2024

jenkins

num_doc_samples_per_dataset = [[None]] * len(data_cfg.doc_file_names)
num_query_files = len(data_cfg.query_file_names) if data_cfg.query_file_names is not None else 0
num_doc_files = len(data_cfg.doc_file_names) if data_cfg.doc_file_names is not None else 0
num_query_samples_per_dataset = [[None]] * num_query_files

Check notice

Code scanning / CodeQL

Unused local variable Note

Variable num_query_samples_per_dataset is not used.
num_query_files = len(data_cfg.query_file_names) if data_cfg.query_file_names is not None else 0
num_doc_files = len(data_cfg.doc_file_names) if data_cfg.doc_file_names is not None else 0
num_query_samples_per_dataset = [[None]] * num_query_files
num_doc_samples_per_dataset = [[None]] * num_doc_files

Check notice

Code scanning / CodeQL

Unused local variable Note

Variable num_doc_samples_per_dataset is not used.
Signed-off-by: arendu <[email protected]>
@github-actions github-actions bot added the CI label Apr 19, 2024
@arendu arendu requested a review from pablo-garay April 19, 2024 21:07
docs/source/nlp/information_retrieval.rst Outdated Show resolved Hide resolved

python3 /NeMo/examples/nlp/information_retrieval/megatron_gpt_embedding_finetuning.py \
exp_manager.exp_dir="PATH_TO_SAVE_LORA_WEIGHTS" \
model.global_batch_size=4 \ # exact choice for global batch size is data dependent typical values are in the rage of 32 to 128.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rage -> range

docs/source/nlp/information_retrieval.rst Outdated Show resolved Hide resolved
docs/source/nlp/information_retrieval.rst Outdated Show resolved Hide resolved
@JRD971000
Copy link
Collaborator

Great doc @arendu , just a few typos to fix. Btw, I saw no Jenkins test, is cicd-main.yml the replacement?

Signed-off-by: Adi Renduchintala <[email protected]>
JRD971000
JRD971000 previously approved these changes Apr 22, 2024
JRD971000
JRD971000 previously approved these changes Apr 23, 2024
Signed-off-by: arendu <[email protected]>
@arendu arendu requested a review from JRD971000 April 24, 2024 00:38
@JRD971000 JRD971000 merged commit 8c8c667 into main Apr 29, 2024
129 checks passed
@JRD971000 JRD971000 deleted the adithyare/docs_gpt_embedding branch April 29, 2024 16:48
suiyoubi pushed a commit that referenced this pull request May 2, 2024
* docs and simplification of cmd args

Signed-off-by: arendu <[email protected]>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* added cicd test

Signed-off-by: arendu <[email protected]>

* added cicd test is needs

Signed-off-by: arendu <[email protected]>

* Update information_retrieval.rst

Signed-off-by: Adi Renduchintala <[email protected]>

* updated to fix wrong file paths

Signed-off-by: arendu <[email protected]>

* update

Signed-off-by: arendu <[email protected]>

* Update cicd-main.yml

Signed-off-by: Adi Renduchintala <[email protected]>

---------

Signed-off-by: arendu <[email protected]>
Signed-off-by: Adi Renduchintala <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Pablo Garay <[email protected]>
Signed-off-by: Ao Tang <[email protected]>
rohitrango pushed a commit to rohitrango/NeMo that referenced this pull request Jun 25, 2024
* docs and simplification of cmd args

Signed-off-by: arendu <[email protected]>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* added cicd test

Signed-off-by: arendu <[email protected]>

* added cicd test is needs

Signed-off-by: arendu <[email protected]>

* Update information_retrieval.rst

Signed-off-by: Adi Renduchintala <[email protected]>

* updated to fix wrong file paths

Signed-off-by: arendu <[email protected]>

* update

Signed-off-by: arendu <[email protected]>

* Update cicd-main.yml

Signed-off-by: Adi Renduchintala <[email protected]>

---------

Signed-off-by: arendu <[email protected]>
Signed-off-by: Adi Renduchintala <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Pablo Garay <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants