Improve validate_applicable_state error messages - Medium Priority Updates (#5127)#5127
Open
shrutipatel31 wants to merge 1 commit intofacebook:mainfrom
Open
Improve validate_applicable_state error messages - Medium Priority Updates (#5127)#5127shrutipatel31 wants to merge 1 commit intofacebook:mainfrom
shrutipatel31 wants to merge 1 commit intofacebook:mainfrom
Conversation
|
@shrutipatel31 has exported this pull request. If you are a Meta employee, you can view the originating Diff in D97528390. |
shrutipatel31
added a commit
to shrutipatel31/Ax
that referenced
this pull request
Apr 2, 2026
…dates (facebook#5127) Summary: Improve validate_applicable_state error messages across ax/analysis to be more user-friendly and descriptive: - Remove self-referential analysis class names from error messages (e.g., "GenerationStrategyGraph requires...", "PredictableMetricsAnalysis requires...", "BaselineImprovementAnalysis requires...") and replace them with action-oriented phrasing (e.g., "A GenerationStrategy must be provided to visualize..."). - Add parenthetical explanations alongside retained domain class names (OptimizationConfig, OutcomeConstraint, ChoiceParameter) to clarify their meaning for users unfamiliar with Ax internals. - Reword the base "Requires an Experiment." message to the more descriptive "An Experiment must be provided to compute this analysis." - Remove backtick formatting around class names in error strings. - Add purpose/context to error messages (e.g., "...to compute probability of feasibility", "...to evaluate baseline improvement"). - Replace "Objective" jargon with plain "single-objective optimization" language in OutcomeConstraintsAnalysis. - Update test assertions to match the new message wording. Audited in https://docs.google.com/document/d/1mxkLvXz0SvdWqO9UrVq5hsFY6MlcwDSk7oVRzdU6kN0/edit?tab=t.0 with the help of an AI Agent Differential Revision: D97528390
c0a0a95 to
6bc9c3b
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5127 +/- ##
==========================================
+ Coverage 96.40% 96.41% +0.01%
==========================================
Files 613 613
Lines 68187 68219 +32
==========================================
+ Hits 65737 65775 +38
+ Misses 2450 2444 -6 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…dates (facebook#5127) Summary: Improve validate_applicable_state error messages across ax/analysis to be more user-friendly and descriptive: - Remove self-referential analysis class names from error messages (e.g., "GenerationStrategyGraph requires...", "PredictableMetricsAnalysis requires...", "BaselineImprovementAnalysis requires...") and replace them with action-oriented phrasing (e.g., "A GenerationStrategy must be provided to visualize..."). - Add parenthetical explanations alongside retained domain class names (OptimizationConfig, OutcomeConstraint, ChoiceParameter) to clarify their meaning for users unfamiliar with Ax internals. - Reword the base "Requires an Experiment." message to the more descriptive "An Experiment must be provided to compute this analysis." - Remove backtick formatting around class names in error strings. - Add purpose/context to error messages (e.g., "...to compute probability of feasibility", "...to evaluate baseline improvement"). - Replace "Objective" jargon with plain "single-objective optimization" language in OutcomeConstraintsAnalysis. - Update test assertions to match the new message wording. Audited in https://docs.google.com/document/d/1mxkLvXz0SvdWqO9UrVq5hsFY6MlcwDSk7oVRzdU6kN0/edit?tab=t.0 with the help of an AI Agent Differential Revision: D97528390
6bc9c3b to
86f076e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary:
Improve validate_applicable_state error messages across ax/analysis
to be more user-friendly and descriptive:
Audited in https://docs.google.com/document/d/1mxkLvXz0SvdWqO9UrVq5hsFY6MlcwDSk7oVRzdU6kN0/edit?tab=t.0 with the help of an AI Agent
Differential Revision: D97528390