Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Generate configuration guide in mvn build #349

Merged
merged 8 commits into from
Apr 30, 2024

Conversation

andygrove
Copy link
Member

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?

Screenshot 2024-04-29 at 10 23 00 AM

How are these changes tested?

Tested manually by running mvn clean package -DskipTests and then generating the documentation.


/**
* Utility for generating markdown documentation from the configs.
*/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you like to put the usage (i.e., mvn clean package -DskipTests) in the code comment here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. Added.

| 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 |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wondering if it is ok to publish internal conf like this one spark.comet.columnar.shuffle.spill.threshold...?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great point. Let me fix that.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I pushed an update to fix this.

Copy link
Contributor

@kazuyukitanimura kazuyukitanimura left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you LGTM

@viirya viirya merged commit 1865284 into apache:main Apr 30, 2024
28 checks passed
@viirya
Copy link
Member

viirya commented 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.
@andygrove andygrove deleted the generate-config-docs branch December 3, 2024 04:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generate markdown documentation for all CometConf entries
3 participants