Skip to content

docs(geneva): add multi-output UDF docs#271

Merged
BubbleCal merged 1 commit into
mainfrom
yang/geneva-multi-output-udf-docs
Jun 12, 2026
Merged

docs(geneva): add multi-output UDF docs#271
BubbleCal merged 1 commit into
mainfrom
yang/geneva-multi-output-udf-docs

Conversation

@BubbleCal

@BubbleCal BubbleCal commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Feature

What is the new feature?

Adds public Geneva documentation for multi-output UDFs on the UDF guide page (/geneva/udfs/udfs). The docs now emphasize the main user benefit: one expensive input read/decode can produce multiple output columns, such as image height, width, and embedding.

Why do we need this feature?

Users may otherwise create separate UDFs for each image-derived feature, causing the same image to be read or decoded multiple times. Multi-output UDFs let users compute related features together and materialize them as sibling columns.

How does it work?

  • Adds a “Registering Multi-Output UDFs” section under “Registering Features with UDFs”.
  • Shows an image example that decodes the image once and returns height, width, and embedding.
  • Documents typing.NamedTuple output shapes and geneva.Columns[YourNamedTuple] return annotations.
  • Documents direct multi-column registration with tbl.add_columns(image_features).
  • Documents prefixed output names with tbl.add_columns(geneva.UnpackedUDF(image_features, prefix="image_")).
  • Clarifies that sibling output columns should be backfilled, dropped, or altered as one logical group.

Validation

  • git diff --check
  • npx -y mintlify@latest broken-links

@mintlify

mintlify Bot commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
lancedb-bcbb4faf 🟢 Ready View Preview Jun 12, 2026, 4:54 PM

@BubbleCal BubbleCal force-pushed the yang/geneva-multi-output-udf-docs branch from 2c319c0 to fb97de5 Compare June 12, 2026 18:02
@BubbleCal BubbleCal marked this pull request as ready for review June 12, 2026 18:06
@BubbleCal BubbleCal requested a review from jmhsieh June 12, 2026 18:06

@justinrmiller justinrmiller 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.

lgtm

@BubbleCal BubbleCal merged commit 8a51a4c into main Jun 12, 2026
2 checks passed
@BubbleCal BubbleCal deleted the yang/geneva-multi-output-udf-docs branch June 12, 2026 18:30
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