Skip to content

Commit 8610967

Browse files
jmhsiehclaude
andauthored
feat: add UDTF documentation and reorganize Geneva docs (#187)
Add two new doc pages for the UDTF features introduced in Geneva 0.11.0: - Scalar UDTFs (1:N row expansion) for chunking, splitting, tiling - Batch UDTFs (N:M transformations) for deduplication, clustering, aggregation Also updates the UDF index page with a UDFs vs UDTFs overview section and adds both pages to the docs.json navigation. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * feat: add UDFs and UDTFs overview page with visual comparisons - Add geneva/overview/udfs-and-udtfs.mdx with table-based illustrations of 1:1, 1:N, and N:M transformations - Move comparison table out of scalar-udtfs into the overview page - Remove UDFs vs UDTFs blurb from UDF index (now in overview) - Use @udtf instead of @geneva.udtf throughout - Update scalar UDTF inherited columns example to exclude duration - Reorder sections: choosing the right type and at-a-glance first Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 1a71767 commit 8610967

File tree

7 files changed

+914
-282
lines changed

7 files changed

+914
-282
lines changed

docs/docs.json

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -159,49 +159,47 @@
159159
"geneva/index",
160160
"geneva/overview/index",
161161
{
162-
"group": "User Defined Functions (UDFs)",
162+
"group": "Transforms",
163163
"pages": [
164164
"geneva/udfs/index",
165-
{
166-
"group": "Built-in Providers",
167-
"pages": [
168-
"geneva/udfs/providers/index",
169-
"geneva/udfs/providers/openai",
170-
"geneva/udfs/providers/gemini",
171-
"geneva/udfs/providers/sentence-transformers"
172-
]
173-
},
174-
"geneva/udfs/blobs",
165+
"geneva/udfs/udfs",
166+
"geneva/udfs/scalar-udtfs",
167+
"geneva/udfs/batch-udtfs",
175168
"geneva/udfs/error_handling",
176-
"geneva/udfs/advanced-configuration"
169+
"geneva/udfs/blobs"
177170
]
178171
},
179172
{
180-
"group": "Jobs",
173+
"group": "Built-in Transforms",
181174
"pages": [
182-
"geneva/jobs/lifecycle",
183-
"geneva/jobs/backfilling",
184-
"geneva/jobs/conflicts",
185-
"geneva/jobs/materialized-views",
186-
"geneva/jobs/performance",
187-
"geneva/jobs/job_metrics",
188-
"geneva/jobs/troubleshooting"
175+
"geneva/udfs/providers/index",
176+
"geneva/udfs/providers/openai",
177+
"geneva/udfs/providers/gemini",
178+
"geneva/udfs/providers/sentence-transformers"
189179
]
190180
},
191181
{
192-
"group": "Operations",
182+
"group": "Running Jobs",
193183
"pages": [
194184
"geneva/jobs/contexts",
195-
"geneva/deployment/dependency-verification",
196-
"geneva/jobs/startup",
197-
"geneva/jobs/console"
185+
"geneva/jobs/backfilling",
186+
"geneva/jobs/materialized-views",
187+
"geneva/jobs/lifecycle",
188+
"geneva/jobs/conflicts",
189+
"geneva/jobs/performance",
190+
"geneva/jobs/job_metrics",
191+
"geneva/jobs/console",
192+
"geneva/jobs/troubleshooting"
198193
]
199194
},
200195
{
201196
"group": "Deployment",
202197
"pages": [
203198
"geneva/deployment/index",
204199
"geneva/deployment/helm",
200+
"geneva/jobs/startup",
201+
"geneva/deployment/dependency-verification",
202+
"geneva/udfs/advanced-configuration",
205203
"geneva/deployment/troubleshooting"
206204
]
207205
},

docs/geneva/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ Feature Engineering and the `geneva` Python package are currently only available
2323
in scaling up your feature engineering workloads for your AI and multimodal use cases.
2424
</Card>
2525

26-
The `geneva` package uses Python [User Defined Functions (UDFs)](/geneva/udfs/) to define features
26+
The `geneva` package uses Python [User Defined Functions (UDFs)](/geneva/udfs/udfs) to define features
2727
as columns in a Lance dataset. Adding a feature is straightforward:
2828

2929
<Steps>
3030
<Step>
3131
Prototype your Python function in your favorite environment.
3232
</Step>
3333
<Step>
34-
Wrap the function with a small UDF decorator (see [UDFs](/geneva/udfs/)).
34+
Wrap the function with a small UDF decorator (see [UDFs](/geneva/udfs/udfs)).
3535
</Step>
3636
<Step>
3737
Register the UDF as a virtual column using `Table.add_columns()`.
@@ -50,6 +50,6 @@ You can build your Python feature generator function in an IDE or a notebook usi
5050
Visit the following pages to learn more about featuring engineering in LanceDB Enterprise:
5151

5252
- **Overview**: [What is Feature Engineering?](/geneva/overview/)
53-
- **UDFs**: [Using UDFs](/geneva/udfs/) · [Blob helpers](/geneva/udfs/blobs/) · [Error handling](/geneva/udfs/error_handling) · [Advanced configuration](/geneva/udfs/advanced-configuration)
53+
- **UDFs**: [Using UDFs](/geneva/udfs/udfs) · [Blob helpers](/geneva/udfs/blobs/) · [Error handling](/geneva/udfs/error_handling) · [Advanced configuration](/geneva/udfs/advanced-configuration)
5454
- **Jobs**: [Backfilling](/geneva/jobs/backfilling/) · [Startup optimizations](/geneva/jobs/startup/) · [Materialized views](/geneva/jobs/materialized-views/) · [Execution contexts](/geneva/jobs/contexts/) · [Geneva console](/geneva/jobs/console) · [Performance](/geneva/jobs/performance/)
5555
- **Deployment**: [Deployment overview](/geneva/deployment/) · [Helm deployment](/geneva/deployment/helm/) · [Troubleshooting](/geneva/deployment/troubleshooting/)

0 commit comments

Comments
 (0)