[SPARK-49532][DOCS][PS] Improve documentation of "plotting.sample_ratio" option #48013
Conversation
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
xinrong-meng
changed the title
HyukjinKwon
approved these changes
Sep 6, 2024
Member
|
Merged to master. |
Member
Author
|
Thank you @HyukjinKwon ! |
IvanK-db
pushed a commit
to IvanK-db/spark
that referenced
this pull request
Sep 20, 2024
…io" option ### What changes were proposed in this pull request? The current documentation incorrectly suggests that "plotting.sample_ratio" **defaults** to "plotting.max_rows". In reality, if "plotting.sample_ratio" is not explicitly set, it is **derived** based on the ratio of "plotting.max_rows" to the dataset size. ### Why are the changes needed? To avoid misunderstandings about how these options interact. ### Does this PR introduce _any_ user-facing change? Doc change only. ### How was this patch tested? Existing tests. ### Was this patch authored or co-authored using generative AI tooling? No. Closes apache#48013 from xinrong-meng/doc_impr. Authored-by: Xinrong Meng <[email protected]> Signed-off-by: Hyukjin Kwon <[email protected]>
attilapiros
pushed a commit
to attilapiros/spark
that referenced
this pull request
Oct 4, 2024
…io" option ### What changes were proposed in this pull request? The current documentation incorrectly suggests that "plotting.sample_ratio" **defaults** to "plotting.max_rows". In reality, if "plotting.sample_ratio" is not explicitly set, it is **derived** based on the ratio of "plotting.max_rows" to the dataset size. ### Why are the changes needed? To avoid misunderstandings about how these options interact. ### Does this PR introduce _any_ user-facing change? Doc change only. ### How was this patch tested? Existing tests. ### Was this patch authored or co-authored using generative AI tooling? No. Closes apache#48013 from xinrong-meng/doc_impr. Authored-by: Xinrong Meng <[email protected]> Signed-off-by: Hyukjin Kwon <[email protected]>
himadripal
pushed a commit
to himadripal/spark
that referenced
this pull request
Oct 19, 2024
…io" option ### What changes were proposed in this pull request? The current documentation incorrectly suggests that "plotting.sample_ratio" **defaults** to "plotting.max_rows". In reality, if "plotting.sample_ratio" is not explicitly set, it is **derived** based on the ratio of "plotting.max_rows" to the dataset size. ### Why are the changes needed? To avoid misunderstandings about how these options interact. ### Does this PR introduce _any_ user-facing change? Doc change only. ### How was this patch tested? Existing tests. ### Was this patch authored or co-authored using generative AI tooling? No. Closes apache#48013 from xinrong-meng/doc_impr. Authored-by: Xinrong Meng <[email protected]> Signed-off-by: Hyukjin Kwon <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What changes were proposed in this pull request?
The current documentation incorrectly suggests that "plotting.sample_ratio" defaults to "plotting.max_rows". In reality, if "plotting.sample_ratio" is not explicitly set, it is derived based on the ratio of "plotting.max_rows" to the dataset size.
Why are the changes needed?
To avoid misunderstandings about how these options interact.
Does this PR introduce any user-facing change?
Doc change only.
How was this patch tested?
Existing tests.
Was this patch authored or co-authored using generative AI tooling?
No.