docs(python): Add example for index count in DataFrame.rolling
#16600
Conversation
This file contains 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
marenwestermann
requested review from
ritchie46,
stinodego,
c-peters,
alexander-beedie,
MarcoGorelli and
reswqa
as code owners
github-actions
bot
added
documentation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #16600 +/- ##
==========================================
+ Coverage 81.51% 81.52% +0.01%
==========================================
Files 1414 1414
Lines 185906 186398 +492
Branches 3027 3014 -13
==========================================
+ Hits 151535 151966 +431
- Misses 33840 33902 +62
+ Partials 531 530 -1 ☔ View full report in Codecov by Sentry. |
py-polars/polars/dataframe/frame.py
Outdated
| @@ -5719,6 +5719,24 @@ def rolling( | |||
| │ 2020-01-03 19:45:32 ┆ 11 ┆ 2 ┆ 9 │ | |||
| │ 2020-01-08 23:16:43 ┆ 1 ┆ 1 ┆ 1 │ | |||
| └─────────────────────┴───────┴───────┴───────┘ | |||
|
|
|||
| The index count is based on actual values in a defined column and not on | |||
There was a problem hiding this comment.
How about
If you use an index count in `period` or `offset`, then it's based on the values in `index_column`:
< your example goes here >
If you want it to be based on row number, then you may want to combine `rolling` with :meth:`.with_row_index`
?
stinodego
changed the title
DataFrame.rollingDataFrame.rolling
MarcoGorelli
approved these changes
Jun 1, 2024
There was a problem hiding this comment.
nice one, thanks @marenwestermann !
towards #14781
I think this closes the issue, right? or is there anything else that needs doing for that one?
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.
towards #14781
I added an example for using the index count in
DataFrame.rollingas there has been unclarity about how exactly it works.