Skip to content

Commit 8f3cee5

Browse files
authored
docs: Documentation updates in preparation for 0.16 release (apache#4244)
1 parent 076fa74 commit 8f3cee5

24 files changed

Lines changed: 187 additions & 161 deletions

File tree

common/src/main/scala/org/apache/comet/CometConf.scala

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -94,12 +94,9 @@ object CometConf extends ShimCometConf {
9494
.createWithEnvVarOrDefault("ENABLE_COMET", true)
9595

9696
val COMET_NATIVE_SCAN_ENABLED: ConfigEntry[Boolean] = conf("spark.comet.scan.enabled")
97-
.category(CATEGORY_SCAN)
98-
.doc(
99-
"Whether to enable native scans. When this is turned on, Spark will use Comet to " +
100-
"read supported data sources (currently only Parquet is supported natively). Note " +
101-
"that to enable native vectorized execution, both this config and " +
102-
"`spark.comet.exec.enabled` need to be enabled.")
97+
.category(CATEGORY_TESTING)
98+
.doc("Whether to enable native scans. Intended for use in Comet's own test suites to " +
99+
"selectively disable native scans; not intended for production use.")
103100
.booleanConf
104101
.createWithDefault(true)
105102

dev/release/build-release-comet.sh

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,10 @@ LOCAL_REPO=$(mktemp -d /tmp/comet-staging-repo-XXXXX)
209209
./mvnw "-Dmaven.repo.local=${LOCAL_REPO}" -P spark-3.4 -P scala-2.13 -DskipTests install
210210
./mvnw "-Dmaven.repo.local=${LOCAL_REPO}" -P spark-3.5 -P scala-2.12 -DskipTests install
211211
./mvnw "-Dmaven.repo.local=${LOCAL_REPO}" -P spark-3.5 -P scala-2.13 -DskipTests install
212-
./mvnw "-Dmaven.repo.local=${LOCAL_REPO}" -P spark-4.0 -P scala-2.13 -DskipTests install
212+
# The spark-4.x profiles pin their own Scala 2.13.x patch versions to match the
213+
# corresponding Spark release, so the scala-2.13 profile is not used here.
214+
./mvnw "-Dmaven.repo.local=${LOCAL_REPO}" -P spark-4.0 -DskipTests install
215+
./mvnw "-Dmaven.repo.local=${LOCAL_REPO}" -P spark-4.1 -DskipTests install
213216

214217
echo "Installed to local repo: ${LOCAL_REPO}"
215218

docs/source/about/gluten_comparison.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ code, then we suggest benchmarking with both solutions and choosing the fastest
6262

6363
Both projects target a similar set of Spark releases.
6464

65-
Comet supports Spark 3.4, 3.5, and 4.0 in production builds, with experimental builds also published for
66-
Spark 4.1 and the Spark 4.2 preview. See the [Spark version compatibility guide] for the exact patch versions and
65+
Comet supports Spark 3.4, 3.5, 4.0, and 4.1 in production builds, with an experimental build also published for
66+
the Spark 4.2 preview. See the [Spark version compatibility guide] for the exact patch versions and
6767
JDK/Scala combinations.
6868

6969
[Spark version compatibility guide]: /user-guide/latest/compatibility/spark-versions.md

docs/source/about/index.md

Lines changed: 0 additions & 73 deletions
This file was deleted.

docs/source/asf/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,14 @@ under the License.
1919

2020
# ASF Links
2121

22+
Apache DataFusion Comet is part of the Apache Software Foundation. The links below point to ASF
23+
resources covering licensing, donations, security reporting, and the Foundation's code of conduct.
24+
Select a link from the navigation menu.
25+
2226
```{toctree}
2327
:maxdepth: 1
2428
:caption: ASF Links
29+
:hidden:
2530
2631
Apache Software Foundation <https://apache.org>
2732
License <https://www.apache.org/licenses/>

docs/source/conf.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -134,16 +134,17 @@
134134
"**": ["docs-sidebar.html"],
135135
}
136136

137-
# tell myst_parser to auto-generate anchor links for headers h1, h2, h3
138-
myst_heading_anchors = 3
137+
# tell myst_parser to auto-generate anchor links for headers h1, h2, h3, h4
138+
myst_heading_anchors = 4
139139

140140
# enable nice rendering of checkboxes for the task lists
141141
myst_enable_extensions = ["colon_fence", "deflist", "tasklist"]
142142

143143
redirects = {
144-
"overview.html": "about/index.html",
144+
"overview.html": "index.html",
145+
"about/index.html": "../index.html",
145146
"gluten_comparison.html": "about/gluten_comparison.html",
146-
"user-guide/overview.html": "../about/overview.html",
147+
"user-guide/overview.html": "../index.html",
147148
"user-guide/gluten_comparison.html": "../about/gluten_comparison.html",
148149
"user-guide/compatibility.html": "latest/compatibility.html",
149150
"user-guide/configs.html": "latest/configs.html",

docs/source/contributor-guide/benchmarking.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,13 @@ Available benchmarking guides:
3939
- [TPC-DS Benchmarking with spark-sql-perf](benchmarking_spark_sql_perf.md)
4040

4141
We also have many micro benchmarks that can be run from an IDE located [here](https://github.com/apache/datafusion-comet/tree/main/spark/src/test/scala/org/apache/spark/sql/benchmark).
42+
43+
```{toctree}
44+
:hidden:
45+
46+
benchmark-results/tpc-h
47+
benchmark-results/tpc-ds
48+
benchmarking_macos
49+
benchmarking_aws_ec2
50+
benchmarking_spark_sql_perf
51+
```

docs/source/contributor-guide/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,21 @@ under the License.
1919

2020
# Comet Contributor Guide
2121

22+
The Comet contributor guide is for developers working on Comet itself. It covers the project
23+
architecture, the JVM and native code layout, the Arrow FFI bridge, JVM and native shuffle, and
24+
how data and plans flow between Spark and the DataFusion execution engine.
25+
26+
It also documents day-to-day workflows including building and testing locally, debugging,
27+
benchmarking, profiling, tracing, running the SQL test suites, adding new operators and
28+
expressions, triaging bugs, and the Comet release process.
29+
30+
New contributors should start with the Getting Started page. Select a topic from the navigation
31+
menu to read more.
32+
2233
```{toctree}
2334
:maxdepth: 2
2435
:caption: Contributor Guide
36+
:hidden:
2537
2638
Getting Started <contributing>
2739
Comet Plugin Overview <plugin_overview>
@@ -30,6 +42,7 @@ JVM Shuffle <jvm_shuffle>
3042
Native Shuffle <native_shuffle>
3143
Development Guide <development>
3244
Debugging Guide <debugging>
45+
ANSI Error Propagation <sql_error_propagation>
3346
Benchmarking Guide <benchmarking>
3447
Adding a New Operator <adding_a_new_operator>
3548
Adding a New Expression <adding_a_new_expression>

docs/source/contributor-guide/roadmap.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,16 @@ significant family of Spark expressions in one effort.
4343

4444
## Dynamic Partition Pruning
4545

46-
Both Iceberg table scans and Parquet V1 native scans (`CometNativeScanExec`) support non-AQE Dynamic Partition Pruning
47-
(DPP) filters generated by Spark's `PlanDynamicPruningFilters` optimizer rule ([#3349], [#3511]). However, Spark's
48-
`PlanAdaptiveDynamicPruningFilters` optimizer rule runs after Comet's rules, so DPP with Adaptive Query Execution
49-
requires a redesign of Comet's plan translation. This effort can be tracked at [#3510].
46+
Native Parquet scans (`CometNativeScanExec`) support Dynamic Partition Pruning (DPP) both with and without
47+
Adaptive Query Execution. Non-AQE DPP landed in [#4011] and AQE DPP with broadcast reuse landed in [#4112].
48+
Iceberg native scans currently support non-AQE DPP only ([#3349], [#3511]); extending broadcast reuse to AQE
49+
DPP for Iceberg is tracked at [#3510].
5050

5151
[#3349]: https://github.com/apache/datafusion-comet/pull/3349
5252
[#3510]: https://github.com/apache/datafusion-comet/issues/3510
5353
[#3511]: https://github.com/apache/datafusion-comet/pull/3511
54+
[#4011]: https://github.com/apache/datafusion-comet/pull/4011
55+
[#4112]: https://github.com/apache/datafusion-comet/pull/4112
5456

5557
## TPC-H and TPC-DS Performance
5658

docs/source/contributor-guide/spark_expressions_support.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -356,23 +356,23 @@
356356
- [x] `/`
357357
- [x] abs
358358
- [x] acos
359-
- [ ] acosh
359+
- [x] acosh
360360
- [x] asin
361-
- [ ] asinh
361+
- [x] asinh
362362
- [x] atan
363363
- [x] atan2
364-
- [ ] atanh
364+
- [x] atanh
365365
- [x] bin
366366
- [ ] bround
367-
- [ ] cbrt
367+
- [x] cbrt
368368
- [x] ceil
369369
- [x] ceiling
370370
- [ ] conv
371371
- [x] cos
372372
- [x] cosh
373373
- [x] cot
374374
- [ ] csc
375-
- [ ] degrees
375+
- [x] degrees
376376
- [ ] div
377377
- [ ] e
378378
- [x] exp
@@ -390,12 +390,12 @@
390390
- [x] log2
391391
- [x] mod
392392
- [x] negative
393-
- [ ] pi
393+
- [x] pi
394394
- [ ] pmod
395395
- [x] positive
396396
- [x] pow
397397
- [x] power
398-
- [ ] radians
398+
- [x] radians
399399
- [x] rand
400400
- [x] randn
401401
- [ ] random

0 commit comments

Comments
 (0)