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: changes in documentation #512

Merged

Conversation

SemyonSinchenko
Copy link
Member

Which issue does this PR close?

Closes #503
Closes #191

Rationale for this change

  1. Provide a way to build Comet from the source on an isolated environments with an access to github.com
  2. Update documentation in part, related to compatibility of Spark AQE and Comet Shuffle

What changes are included in this PR?

  • Update tuning section about the compatibility of Shuffle and Spark AQE
  • Add release-nogit for building on an isolated environments
  • Update docs in the section about an installation process

Changes to be committed:
modified: Makefile
modified: docs/source/user-guide/installation.md
modified: docs/source/user-guide/tuning.md

How are these changes tested?

I run both make release and make release-nogit. The first one created properties file in common/target/classes but the second did not. The flag -Dmaven.gitcommitid.skip=true is described in this comment.

- Update tuning section about the compatibility of Shuffle and Spark AQE
- Add `release-nogit` for building on an isolated environments
- Update docs in the section about an installation process

 On branch docs-tuning-section-update
 Changes to be committed:
	modified:   Makefile
	modified:   docs/source/user-guide/installation.md
	modified:   docs/source/user-guide/tuning.md
@andygrove
Copy link
Member

The CI failures with Spark 4 can be fixed by merging latest from main branch

@andygrove
Copy link
Member

andygrove commented Jun 4, 2024

Please ignore. I found the issue and was my error.

I'm testing out the Makefile change as part of another PR where I ran into the same issue, but am getting

make: Nothing to be done for `release-nogit'.

Any ideas?

Copy link
Member

@andygrove andygrove left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks @SemyonSinchenko

@@ -39,6 +39,8 @@ It must be set before the Spark context is created. You can enable or disable Co
at runtime by setting `spark.comet.exec.shuffle.enabled` to `true` or `false`.
Once it is disabled, Comet will fallback to the default Spark shuffle manager.

> **_NOTE:_** At the moment Comet Shuffle is not compatible with Spark AQE partition coalesce. To disable set `spark.sql.adaptive.coalescePartitions.enabled` to `false`.
Copy link
Member

Choose a reason for hiding this comment

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

👍

@kazuyukitanimura kazuyukitanimura merged commit c819bc0 into apache:main Jun 5, 2024
43 checks passed
@kazuyukitanimura
Copy link
Contributor

Thank you @SemyonSinchenko @andygrove @viirya merged

himadripal pushed a commit to himadripal/datafusion-comet that referenced this pull request Sep 7, 2024
## Which issue does this PR close?
Closes apache#503
Closes apache#191 

## Rationale for this change

1. Provide a way to build Comet from the source on an isolated environments with an access to github.com
2. Update documentation in part, related to compatibility of Spark AQE and Comet Shuffle

## What changes are included in this PR?

- Update tuning section about the compatibility of Shuffle and Spark AQE
- Add `release-nogit` for building on an isolated environments
- Update docs in the section about an installation process


 Changes to be committed:
	modified:   Makefile
	modified:   docs/source/user-guide/installation.md
	modified:   docs/source/user-guide/tuning.md

## How are these changes tested?

I run both `make release` and `make release-nogit`. The first one created properties file in `common/target/classes` but the second did not. The flag `-Dmaven.gitcommitid.skip=true` is described in [this comment](git-commit-id/git-commit-id-maven-plugin#392 (comment)).
@SemyonSinchenko SemyonSinchenko deleted the docs-tuning-section-update branch November 23, 2024 09:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants