-
Notifications
You must be signed in to change notification settings - Fork 0
docs: clarify outlier limits are calculated across all variants #245
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
base: development
Are you sure you want to change the base?
Conversation
WalkthroughThis pull request updates the web console documentation for metrics creation, specifically the section on outlier handling and limit calculations. The changes introduce a new subsection explaining how limits are calculated for Quantile and Standard Deviation methods—noting that bounds are computed across all experiment participants collectively rather than per-variant. The documentation expands the Unlimited option section with a clarifying note and provides detailed explanations with examples for Quantile, Standard Deviation, and Fixed outlier methods. Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/web-console-docs/goals-and-metrics/metrics/create.mdx (2)
185-201: Fix “removed” vs “capped” inconsistency in Fixed limits description.Line 185 says values outside bounds are “removed”, but the example on Line 201 shows capping, and earlier text defines outlier handling as capping. This is contradictory and will mislead users. Align the wording with the actual behaviour.
🔧 Proposed doc fix
-This option lets you define explicit numeric boundaries. Any value below the lower limit or above the upper limit **is removed**. +This option lets you define explicit numeric boundaries. Any value below the lower limit or above the upper limit **is capped to the nearest boundary**.
174-178: Clarify multiplier = 0 behaviour to match the stated formula.The formula defines limits as mean ± (stdev × multiplier), but the bullets say “keeps all values below/above the mean” when multiplier is 0. With capping, multiplier 0 implies values beyond the mean are capped to the mean, not kept. Either update the bullets to reflect capping, or adjust the formula/text to explain a special-case “disabled side” behaviour if that is the real implementation.
🔧 Proposed doc fix (if capping follows the stated formula)
-Setting multipliers to 0 effectively disables trimming on that side: -- Lower multiplier 0 → lower limit = mean → keeps all values below the mean -- Upper multiplier 0 → upper limit = mean → keeps all values above the mean - -Setting both to 0 is the equivalent of setting no outlier limit. +Setting multipliers to 0 sets the limit to the mean on that side: +- Lower multiplier 0 → lower limit = mean → values below the mean are capped to the mean +- Upper multiplier 0 → upper limit = mean → values above the mean are capped to the mean + +Setting both to 0 caps all values to the mean.
✅ Deploy Preview for absmartly-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Summary
Context
This addresses a common question about whether outlier capping uses control group bounds or variant-specific bounds. The answer (confirmed by code analysis) is that limits are computed from all participants combined.
Test plan
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.