docs: Generate configuration guide in mvn build #349
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
viirya
reviewed
Apr 29, 2024
|
|
||
| /** | ||
| * Utility for generating markdown documentation from the configs. | ||
| */ |
There was a problem hiding this comment.
Would you like to put the usage (i.e., mvn clean package -DskipTests) in the code comment here?
viirya
approved these changes
Apr 29, 2024
kazuyukitanimura
approved these changes
Apr 29, 2024
docs/source/user-guide/configs.md
Outdated
| | spark.comet.columnar.shuffle.batch.size | Batch size when writing out sorted spill files on the native side. Note that this should not be larger than batch size (i.e., `spark.comet.batchSize`). Otherwise it will produce larger batches than expected in the native operator after shuffle. | 8192 | | ||
| | spark.comet.columnar.shuffle.enabled | Force Comet to only use columnar shuffle for CometScan and Spark regular operators. If this is enabled, Comet native shuffle will not be enabled but only Arrow shuffle. By default, this config is false. | false | | ||
| | spark.comet.columnar.shuffle.memory.factor | Fraction of Comet memory to be allocated per executor process for Comet shuffle. Comet memory size is specified by `spark.comet.memoryOverhead` or calculated by `spark.comet.memory.overhead.factor` * `spark.executor.memory`. By default, this config is 1.0. | 1.0 | | ||
| | spark.comet.columnar.shuffle.spill.threshold | Number of rows to be spilled used for Comet columnar shuffle. For every configured number of rows, a new spill file will be created. Higher value means more memory requirement to buffer shuffle data before flushing to disk. As Comet uses columnar shuffle which is columnar format, higher value usually helps to improve shuffle data compression ratio. This is internal config for testing purpose or advanced tuning. By default, this config is Int.Max. | 2147483647 | |
There was a problem hiding this comment.
Wondering if it is ok to publish internal conf like this one spark.comet.columnar.shuffle.spill.threshold...?
There was a problem hiding this comment.
Great point. Let me fix that.
There was a problem hiding this comment.
I pushed an update to fix this.
viirya
approved these changes
Apr 30, 2024
|
Merged. Thanks @andygrove @kazuyukitanimura |
himadripal
pushed a commit
to himadripal/datafusion-comet
that referenced
this pull request
Sep 7, 2024
* initial config doc * Generate configuration guide as part of mvn package * formatting * scalafix * add maven usage to comment * do not publish internal configs * improve check for public configs
himadripal
pushed a commit
to himadripal/datafusion-comet
that referenced
this pull request
Sep 7, 2024
It looks like the `dev/bump-version.sh` script wasn't used.
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 #315
Rationale for this change
We should publish our configuration settings so that users know about them.
What changes are included in this PR?
How are these changes tested?
Tested manually by running
mvn clean package -DskipTestsand then generating the documentation.