[data/docs] Rewrote docstring for AggregateFn, including a usage example #50345
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
Signed-off-by: Ricardo Decal <[email protected]>
richardliaw
changed the title
richardliaw
reviewed
Feb 8, 2025
richardliaw
reviewed
Feb 8, 2025
richardliaw
reviewed
Feb 8, 2025
* fixed whitespace * removed redundant typing * changed to testcode doc flag Signed-off-by: Ricardo Decal <[email protected]>
|
ty for the review @richardliaw ! feedback addressed |
Signed-off-by: Ricardo Decal <[email protected]>
Signed-off-by: Ricardo Decal <[email protected]>
richardliaw
added
docs
richardliaw
reviewed
Feb 11, 2025
Signed-off-by: Ricardo Decal <[email protected]>
richardliaw
approved these changes
Feb 11, 2025
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.
Why are these changes needed?
The current docstring for AggregateFn is very poor. This still does not adequately explain how accumulate_block works, but it is a step in the right direction. I struggled to figure out how this class works while writing a blog post and I am sharing my learnings back into the docs.
Related issue number
Closes #9335 (opened July 2020!)
Relates to #10983
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.