[doc][data] auto-gen GroupedData api #46925
Merged
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
can-anyscale
requested review from
ericl,
scv119,
c21,
amogkam,
scottjlee,
bveeramani,
raulchen,
stephanie-wang and
omatthew98
as code owners
bveeramani
approved these changes
Aug 6, 2024
| :toctree: doc/ | ||
|
|
||
| aggregate.AggregateFn | ||
| .. include:: ray.data.grouped_data.GroupedData.rst |
There was a problem hiding this comment.
@can-anyscale not blocking since this is already an issue, but is there a way to hide the constructor for GroupedData? It shouldn't be exposed to the user
There was a problem hiding this comment.
lol i see, i think so yes - but without a constructor, how users can create an object to invoke the its public methods?
There was a problem hiding this comment.
Users should call the Dataset.groupby() method
can-anyscale
commented
Aug 6, 2024
| @@ -32,7 +35,6 @@ def __repr__(self) -> str: | |||
| return "T" + self.data.__repr__() | |||
|
|
|||
|
|
|||
| @PublicAPI | |||
There was a problem hiding this comment.
@bveeramani: i remove this annotation at the class level; and if this is missing, we assume its constructor is private
So we omit the constructor in the doc now, let me know if you like it, thankks
Signed-off-by: can <[email protected]>
documentation Signed-off-by: can <[email protected]>
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.
Use
_autogento auto-generateGroupedDataapi documentation, so that we don't need to enumerate the list of public APIs anymore. Note that in the new look, constructor is un-folded by default. This is to be consistent with how we document classes elsewhere (e.g. https://docs.ray.io/en/latest/data/api/dataset.html)readthedoc is currently broken on master which is unrelated to this change
Before:
After:
Test: