fix: correct WMA calculation to use nansum instead of nanmean#2109
Open
ayushozha wants to merge 1 commit intomicrosoft:mainfrom
Open
fix: correct WMA calculation to use nansum instead of nanmean#2109ayushozha wants to merge 1 commit intomicrosoft:mainfrom
ayushozha wants to merge 1 commit intomicrosoft:mainfrom
Conversation
…oft#1993) The weighted_mean function normalizes weights to sum to 1, so np.nanmean (which divides by count) produces incorrect results. Use np.nansum instead, consistent with the EMA implementation.
|
I ran into the same WMA bug independently and wrote a regression test for it. Rather than filing a duplicate PR I'd like to offer the test here for you to fold into this branch (or for a maintainer to pick up if this one has stalled). Verified locally: with this branch's one-line fix applied, the test passes against the mock TW 0050 close series in def test_WMA(self):
# Regression test for issue #1993: WMA.weighted_mean divided by the
# window length twice (normalized weights, then np.nanmean) producing
# values ~N times smaller than a correct weighted moving average.
# The sister operator EMA.exp_weighted_mean correctly uses np.nansum.
N = 5
field = f"WMA($close, {N})"
result = ExpressionD.expression(self.instrument, field, self.start_time, self.end_time, self.freq)
result = result.to_numpy()
close = self.mock_df["close"].reset_index(drop=True).to_numpy()
def reference_weighted_mean(x):
w = np.arange(len(x)) + 1
w = w / w.sum()
return np.nansum(w * x)
golden = (
pd.Series(close)
.rolling(N, min_periods=1)
.apply(reference_weighted_mean, raw=True)
.to_numpy()
)
np.testing.assert_allclose(result, golden, rtol=1e-5)
# A weighted moving average with non-negative weights summing to one
# must stay inside the input series' range. The pre-fix implementation
# produced values ~close/N, far below close.min().
close_min = float(np.nanmin(close))
close_max = float(np.nanmax(close))
self.assertGreaterEqual(float(np.nanmin(result)), close_min - 1e-9)
self.assertLessEqual(float(np.nanmax(result)), close_max + 1e-9)Requires Validated with: |
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
Closes #1993
The
weighted_meanfunction inWMA._load_internal(qlib/data/ops.py) normalizes weights to sum to 1 viaw = w / w.sum(), then incorrectly usesnp.nanmean(w * x)which divides by the element count again. The correct function isnp.nansum(w * x)since the weights already sum to 1.This is consistent with how
EMA.exp_weighted_meanis implemented (which already usesnp.nansum).Before
After
Test Plan