Skip to content

Add comprehensive README.md#12

Merged
athitten merged 19 commits intomainfrom
readme
Jul 17, 2025
Merged

Add comprehensive README.md#12
athitten merged 19 commits intomainfrom
readme

Conversation

@athitten
Copy link
Copy Markdown
Contributor

@athitten athitten commented Jul 8, 2025

Add README.md

@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot bot commented Jul 8, 2025

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

Copy link
Copy Markdown
Contributor

@marta-sd marta-sd left a comment

Choose a reason for hiding this comment

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

Looks really good! I added some minor comments

@athitten athitten self-assigned this Jul 8, 2025
README.md Outdated
## 🚀 Features

- **Multi-Backend Deployment**: Support for both PyTriton and Ray Serve deployment backends
- **Comprehensive Evaluation**: Integration with NVIDIA Evals Factory for standardized benchmark evaluation
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

So at this point, the user is not introduced to what Evals Factory is, and how it relates to evaluation being comprehensive.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Addressed this above in 56873d5, by adding some details about what NVIDIA Evals Factory is at the beginning. WDYT @shashank3959 ?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Not relevant anymore since we decided to not use the term NVIDIA Evals Factory in the initial sections. Replaced with state-of-the-art evaluation harnesses under features

pablo-garay
pablo-garay previously approved these changes Jul 9, 2025
Copy link
Copy Markdown
Contributor

@marta-sd marta-sd left a comment

Choose a reason for hiding this comment

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

I verified with the management that "NVIDIA Eval Factory" is the correct name. I think I suggested changes for all occurrences. Sorry for the back and forth.

@ko3n1g
Copy link
Copy Markdown
Collaborator

ko3n1g commented Jul 10, 2025

/ok to test 28730d4

@ko3n1g
Copy link
Copy Markdown
Collaborator

ko3n1g commented Jul 10, 2025

/ok to test d8851a5

athitten and others added 10 commits July 15, 2025 11:30
Co-authored-by: Wenwen Gao <94138584+snowmanwwg@users.noreply.github.com>
Co-authored-by: Wenwen Gao <94138584+snowmanwwg@users.noreply.github.com>
Co-authored-by: Wenwen Gao <94138584+snowmanwwg@users.noreply.github.com>
Signed-off-by: Abhishree <abhishreetm@gmail.com>
Signed-off-by: Abhishree <abhishreetm@gmail.com>
Signed-off-by: Abhishree <abhishreetm@gmail.com>
Signed-off-by: Abhishree <abhishreetm@gmail.com>
Signed-off-by: Abhishree <abhishreetm@gmail.com>
Signed-off-by: Abhishree <abhishreetm@gmail.com>
Signed-off-by: Abhishree <abhishreetm@gmail.com>
[![Python](https://img.shields.io/badge/python-3.10+-blue.svg)](https://github.com/NVIDIA-NeMo/Eval/blob/main/pyproject.toml)
[![NVIDIA](https://img.shields.io/badge/NVIDIA-NeMo-red.svg)](https://github.com/NVIDIA-NeMo/)

[Documentation](https://nemo-framework-documentation.gitlab-master-pages.nvidia.com/eval-build/) | [Examples](#-usage-examples) | [Contributing](https://github.com/NVIDIA-NeMo/Eval/blob/main/CONTRIBUTING.md)
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Documentation link does not work yet since the docs PR #4 is not merged. Once merged and the build is added in gitlab repo, this link should work. Will verify the link once this is done.

@athitten athitten mentioned this pull request Jul 16, 2025
Comment on lines +83 to +98
```bash
# Run all tests
pytest tests

# Run unit tests only
pytest tests/unit_tests/

# Run functional tests only
pytest tests/functional_tests/

# Run with coverage
pytest --cov=nemo_eval tests
```

#### Test Scripts

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Let's remove this. I think it's better to point to the scripts that we use in CI

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yeah we can remove this. Can you point me to the CI scripts you are refering to here ? Thanks!

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@ko3n1g could you please help modify this in a follow up ? Thanks!

@ko3n1g
Copy link
Copy Markdown
Collaborator

ko3n1g commented Jul 16, 2025

/ok to test b83bbce

Signed-off-by: Abhishree <abhishreetm@gmail.com>
@athitten
Copy link
Copy Markdown
Contributor Author

Fast merging since its README. linting, copyright and DCO checks have passed.
cc: @ko3n1g

@athitten athitten merged commit 626cc15 into main Jul 17, 2025
4 checks passed
@athitten athitten deleted the readme branch July 17, 2025 05:53
ko3n1g added a commit that referenced this pull request Sep 22, 2025
Signed-off-by: Abhishree <abhishreetm@gmail.com>
Signed-off-by: oliver könig <okoenig@nvidia.com>
Co-authored-by: oliver könig <okoenig@nvidia.com>
Co-authored-by: Wenwen Gao <94138584+snowmanwwg@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants