Skip to content

chore: Merge reqs and cleanup docs#81

Merged
arekay-nv merged 1 commit intomainfrom
arekay/chore_docs_cleanup
Jan 5, 2026
Merged

chore: Merge reqs and cleanup docs#81
arekay-nv merged 1 commit intomainfrom
arekay/chore_docs_cleanup

Conversation

@arekay-nv
Copy link
Copy Markdown
Collaborator

Merges the dev.txt requirements into base.txt so there is only one requirement file for basic execution.

Type of change

  • Bug fix
  • New feature
  • Documentation update
  • Refactor/cleanup

Related issues

Testing

  • Tests added/updated
  • All tests pass locally
  • Manual testing completed

Checklist

  • Code follows project style
  • Pre-commit hooks pass
  • Documentation updated (if needed)

Signed-off-by: Rashid Kaleem <230885705+arekay-nv@users.noreply.github.com>
Copilot AI review requested due to automatic review settings January 2, 2026 23:36
@arekay-nv arekay-nv requested a review from a team as a code owner January 2, 2026 23:36
@arekay-nv arekay-nv requested review from nv-alicheng and viraatc and removed request for Copilot and viraatc January 2, 2026 23:36
@github-actions
Copy link
Copy Markdown

github-actions bot commented Jan 2, 2026

MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅

@github-actions github-actions bot requested a review from nvzhihanj January 2, 2026 23:37
@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello @arekay-nv, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly streamlines the project's dependency management by consolidating all development requirements into the base.txt file, simplifying the setup process for both basic execution and development environments. Concurrently, it refines various documentation files to accurately reflect these dependency changes, update CLI command usage, remove outdated information, and introduce new examples, thereby enhancing the clarity and usability of the project's guides for all contributors.

Highlights

  • Dependency Management Consolidation: The dev.txt requirements file has been merged into base.txt, establishing a single, comprehensive requirements file for basic execution and development.
  • Documentation Updates for CLI: The CLI_QUICK_REFERENCE.md has been updated to reflect changes in benchmark command options, specifically replacing --report-path with --report-dir and removing the --output flag from from-config examples. The jsonl dataset format is now explicitly listed as supported, removing its 'Coming Soon' status.
  • Development Workflow Documentation Refinement: The DEVELOPMENT.md guide has been updated to align with the consolidated base.txt for installing and updating dependencies. The GITHUB_SETUP.md has removed the 'Branch Validator' section.
  • New Examples Added: The examples/README.md now includes new entries for 04_GPTOSS120B_Example and 05_Llama3.1-8B_Example, providing more benchmark configuration samples.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request successfully merges the development dependencies from dev.txt into base.txt, simplifying the dependency management by reducing the number of requirement files. The documentation has been updated accordingly to reflect these changes, including modifications to the CLI reference.

My review focuses on ensuring consistency in the updated documentation and dependency specifications. I've identified a contradiction in the development guide regarding test dependencies and a potential stability issue with the versioning strategy for pytest and its plugins in the updated requirements/base.txt file. Addressing these points will improve clarity for developers and enhance the long-term stability of the project's dependencies.

@arekay-nv arekay-nv merged commit d562427 into main Jan 5, 2026
5 checks passed
@arekay-nv arekay-nv deleted the arekay/chore_docs_cleanup branch January 5, 2026 18:08
@github-actions github-actions bot locked and limited conversation to collaborators Jan 5, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants