Skip to content

add validate() method to InferenceConfig#105

Merged
chaokunyang merged 1 commit into
inclusionAI:mainfrom
alekseevpavel04:add-validate-method-to-inferenceconfig
Apr 13, 2026
Merged

add validate() method to InferenceConfig#105
chaokunyang merged 1 commit into
inclusionAI:mainfrom
alekseevpavel04:add-validate-method-to-inferenceconfig

Conversation

@alekseevpavel04

Copy link
Copy Markdown
Contributor

What does this PR do?

InferenceConfig has no validation at all, so bad values like engine_rank >= num_engines, an unknown comm_backend, or dump_weights_list_for_validation set without a dump dir fail silently or blow up somewhere deep at runtime. Added a validate() method that checks field consistency (rank bounds, backend names, parallelism sizes >= 1, ep dependency rules, etc.) and raises InferenceConfigValidationError with a clear message listing all problems at once. from_dict() now calls it automatically since that is the main path for loading external configs. validated() is also available for chaining when constructing manually.

Related issues

N/A

Does this PR introduce any user-facing change?

  • Does this PR introduce any public API change?
  • Does this PR introduce any binary protocol compatibility change?

@gemini-code-assist

Copy link
Copy Markdown

Summary of Changes

Hello, 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 enhances the robustness of the InferenceConfig class by integrating a thorough validation mechanism. It ensures that configuration parameters adhere to predefined rules and interdependencies, catching potential issues early during configuration loading or construction rather than at runtime. This change improves developer experience by providing immediate and clear feedback on invalid configurations.

Highlights

  • Configuration Validation: Introduced a comprehensive validate() method within the InferenceConfig class to check for consistency and correctness of configuration fields, preventing silent failures or runtime errors caused by invalid settings.
  • Error Handling: Added a new exception type, InferenceConfigValidationError, which is raised by the validate() method with a clear message listing all detected problems.
  • Automatic Validation: The from_dict() static method now automatically calls validate() after creating an InferenceConfig instance, ensuring that configurations loaded from dictionaries are always valid.
  • Chaining Utility: Provided a validated() method that calls validate() and returns self, allowing for convenient chaining when manually constructing or modifying InferenceConfig objects.

🧠 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.

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.

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

Copy link
Copy Markdown

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 introduces a validate() method to the InferenceConfig class, significantly improving configuration robustness by catching invalid or inconsistent settings early. The from_dict() method now automatically calls this validation, ensuring that configurations loaded from external sources are always valid. A new InferenceConfigValidationError exception is also added for clearer error reporting. The changes are well-implemented and enhance the reliability of the system.

Comment thread awex/config.py
# comm_backend must be one of the known values
if self.comm_backend not in _VALID_COMM_BACKENDS:
errors.append(
f"comm_backend must be one of {sorted(_VALID_COMM_BACKENDS)}, got {self.comm_backend!r}"

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The sorted(_VALID_COMM_BACKENDS) call creates a new list object every time the validate method is invoked. While this is a minor overhead for small sets, it's an unnecessary repeated computation. Additionally, formatting the list directly in the f-string might not produce the most user-friendly output. Consider joining the sorted elements for a cleaner error message.

Suggested change
f"comm_backend must be one of {sorted(_VALID_COMM_BACKENDS)}, got {self.comm_backend!r}"
f"comm_backend must be one of {', '.join(sorted(_VALID_COMM_BACKENDS))}, got {self.comm_backend!r}"

Comment thread awex/config.py
Comment on lines +107 to +108
f"weights_exchange_ipc_backend must be one of {sorted(_VALID_IPC_BACKENDS)}, "
f"got {self.weights_exchange_ipc_backend!r}"

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

Similar to the _VALID_COMM_BACKENDS comment, calling sorted(_VALID_IPC_BACKENDS) repeatedly can lead to minor inefficiencies. For improved readability of the error message, consider joining the sorted elements into a comma-separated string.

Suggested change
f"weights_exchange_ipc_backend must be one of {sorted(_VALID_IPC_BACKENDS)}, "
f"got {self.weights_exchange_ipc_backend!r}"
f"weights_exchange_ipc_backend must be one of {', '.join(sorted(_VALID_IPC_BACKENDS))}, "
f"got {self.weights_exchange_ipc_backend!r}"

@chaokunyang chaokunyang merged commit b9f7e63 into inclusionAI:main Apr 13, 2026
3 checks passed
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.

2 participants