Skip to content

docs: adopt issue #4419 terminology in Scala/Java UDF guide#4651

Open
andygrove wants to merge 1 commit into
apache:mainfrom
andygrove:docs-terminology-udf-4419
Open

docs: adopt issue #4419 terminology in Scala/Java UDF guide#4651
andygrove wants to merge 1 commit into
apache:mainfrom
andygrove:docs-terminology-udf-4419

Conversation

@andygrove

Copy link
Copy Markdown
Member

Which issue does this PR close?

Part of #4419.

Rationale for this change

Issue #4419 proposes a terminology framework to remove the overloaded, bare use of "native" from Comet's docs. The "Scala UDF and Java UDF Support" page describes how UDFs participate in Comet execution and used "native Comet path" / "native path" / "native execution" loosely. This page is a good follow-up to the Understanding Comet Plans cleanup because Scala/Java UDFs are JVM-implemented (codegen'd) yet still run inside the Comet pipeline, so precise wording matters here.

This PR keeps the change scoped to that one page.

What changes are included in this PR?

In docs/source/user-guide/latest/scala_java_udfs.md:

  • Use "Comet pipeline" for pipeline membership in place of "native Comet path" / "native path".
  • Describe the surrounding accelerated operators as "Rust-implemented" rather than "native".
  • Replace "for native execution" / "runs as one native unit" with "to keep execution in the Comet pipeline" / "runs as one unit in the Comet pipeline".

How are these changes tested?

Documentation-only change. Verified with prettier --check.

Replace bare uses of "native" with terms from the apache#4419 framework:
"Comet pipeline" for pipeline membership, "Rust-implemented" for the
surrounding operators, and "run in the Comet pipeline" / "keep execution
in the Comet pipeline" in place of "native path" / "native execution".
@andygrove andygrove added this to the 0.17.0 milestone Jun 13, 2026
| `spark.comet.exec.scalaUDF.codegen.enabled` | `true` | When `true`, eligible `ScalaUDF`s run on the Comet path. When `false`, the enclosing operator falls back to Spark. |
| Key | Default | Description |
| ------------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------- |
| `spark.comet.exec.scalaUDF.codegen.enabled` | `true` | When `true`, eligible `ScalaUDF`s run in the Comet pipeline. When `false`, the enclosing operator falls back to Spark. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

perhaps we need to highlight this param contols a fallback for user defined functions codegen, having another config for builtin Spark functions codegen?

@comphead comphead left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks @andygrove overall it is a good improvement

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.

2 participants