feat: Add COMET_SHUFFLE_MODE config to control Comet shuffle mode #460
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
viirya
force-pushed
the
auto_shuffle_config
branch
8 times, most recently
from
8660c0c to
2bb0efd
Compare
andygrove
reviewed
May 23, 2024
|
|
||
|
|
||
|
|
||
| `spark.comet.exec.shuffle.mode` to `auto` will let Comet choose the best shuffle mode based on the query plan. |
viirya
force-pushed
the
auto_shuffle_config
branch
2 times, most recently
from
07c9ba2 to
f3f46bd
Compare
|
cc @sunchao |
sunchao
reviewed
May 23, 2024
| "By default, this config is 'jvm'.") | ||
| .stringConf | ||
| .transform(_.toLowerCase(Locale.ROOT)) | ||
| .checkValues(Set("native", "jvm", "auto")) |
docs/source/user-guide/configs.md
Outdated
| @@ -39,6 +38,7 @@ Comet provides the following configuration settings. | |||
| | spark.comet.exec.memoryFraction | The fraction of memory from Comet memory overhead that the native memory manager can use for execution. The purpose of this config is to set aside memory for untracked data structures, as well as imprecise size estimation during memory acquisition. Default value is 0.7. | 0.7 | | |||
| | spark.comet.exec.shuffle.codec | The codec of Comet native shuffle used to compress shuffle data. Only zstd is supported. | zstd | | |||
| | spark.comet.exec.shuffle.enabled | Whether to enable Comet native shuffle. By default, this config is false. Note that this requires setting 'spark.shuffle.manager' to 'org.apache.spark.sql.comet.execution.shuffle.CometShuffleManager'. 'spark.shuffle.manager' must be set before starting the Spark application and cannot be changed during the application. | false | | |||
| | spark.comet.exec.shuffle.mode | The mode of Comet shuffle. This config is only effective only if Comet shuffle is enabled. Available modes are 'native', 'jvm', and 'auto'. 'native' is for native shuffle which has best performance in general.'jvm' is for jvm-based columnar shuffle which has higher coverage than native shuffle.'auto' is for Comet to choose the best shuffle mode based on the query plan.By default, this config is 'jvm'. | jvm | | |||
There was a problem hiding this comment.
is only effective only -> is only effective
docs/source/user-guide/configs.md
Outdated
| @@ -39,6 +38,7 @@ Comet provides the following configuration settings. | |||
| | spark.comet.exec.memoryFraction | The fraction of memory from Comet memory overhead that the native memory manager can use for execution. The purpose of this config is to set aside memory for untracked data structures, as well as imprecise size estimation during memory acquisition. Default value is 0.7. | 0.7 | | |||
| | spark.comet.exec.shuffle.codec | The codec of Comet native shuffle used to compress shuffle data. Only zstd is supported. | zstd | | |||
| | spark.comet.exec.shuffle.enabled | Whether to enable Comet native shuffle. By default, this config is false. Note that this requires setting 'spark.shuffle.manager' to 'org.apache.spark.sql.comet.execution.shuffle.CometShuffleManager'. 'spark.shuffle.manager' must be set before starting the Spark application and cannot be changed during the application. | false | | |||
| | spark.comet.exec.shuffle.mode | The mode of Comet shuffle. This config is only effective only if Comet shuffle is enabled. Available modes are 'native', 'jvm', and 'auto'. 'native' is for native shuffle which has best performance in general.'jvm' is for jvm-based columnar shuffle which has higher coverage than native shuffle.'auto' is for Comet to choose the best shuffle mode based on the query plan.By default, this config is 'jvm'. | jvm | | |||
There was a problem hiding this comment.
also spaces before jvm and auto
| Seq(true, false).foreach { cometColumnShuffleEnabled => | ||
| withSQLConf( | ||
| CometConf.COMET_COLUMNAR_SHUFFLE_ENABLED.key -> cometColumnShuffleEnabled.toString) { | ||
| Seq("native", "jvm").foreach { cometColumnShuffleEnabled => |
There was a problem hiding this comment.
nit: maybe update the variable name too
| @@ -134,14 +134,14 @@ class CometExecSuite extends CometTestBase { | |||
| .toDF("c1", "c2") | |||
| .createOrReplaceTempView("v") | |||
|
|
|||
| Seq(true, false).foreach { columnarShuffle => | |||
| Seq("native", "jvm").foreach { columnarShuffle => | |||
When it is |
|
Thank you @sunchao |
viirya
force-pushed
the
auto_shuffle_config
branch
from
678cd8c to
0c8f0f9
Compare
Weird. CI reports the above compilation error, but I don't see |
|
Oh, it is from one patch just merged. |
viirya
force-pushed
the
auto_shuffle_config
branch
from
0c8f0f9 to
586e1a7
Compare
kazuyukitanimura
approved these changes
May 23, 2024
|
Merged. Thanks @sunchao @kazuyukitanimura @andygrove |
himadripal
pushed a commit
to himadripal/datafusion-comet
that referenced
this pull request
Sep 7, 2024
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.
Which issue does this PR close?
Closes #459.
Rationale for this change
What changes are included in this PR?
How are these changes tested?