Skip to content

feat: add UDTF documentation and reorganize Geneva docs #187

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.

Sign up for GitHub

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

Merged
jmhsieh merged 4 commits into from
Mar 13, 2026
Merged

feat: add UDTF documentation and reorganize Geneva docs #187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
698d43a
feat: add scalar UDTF and batch UDTF documentation (Geneva 0.11.0 beta)
jmhsieh Mar 13, 2026
e6beeaf
feat: add UDFs and UDTFs overview page with visual comparisons
jmhsieh Mar 13, 2026
d64a4ed
chore: reorganize Geneva docs nav and polish page titles
jmhsieh Mar 13, 2026
f60a158
chore: fix nav structure and clean up trailing spaces
jmhsieh Mar 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 22 additions & 24 deletions docs/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,49 +159,47 @@
"geneva/index",
"geneva/overview/index",
{
"group": "User Defined Functions (UDFs)",
"group": "Transforms",
"pages": [
"geneva/udfs/index",
{
"group": "Built-in Providers",
"pages": [
"geneva/udfs/providers/index",
"geneva/udfs/providers/openai",
"geneva/udfs/providers/gemini",
"geneva/udfs/providers/sentence-transformers"
]
},
"geneva/udfs/blobs",
"geneva/udfs/udfs",
"geneva/udfs/scalar-udtfs",
"geneva/udfs/batch-udtfs",
"geneva/udfs/error_handling",
"geneva/udfs/advanced-configuration"
"geneva/udfs/blobs"
]
},
{
"group": "Jobs",
"group": "Built-in Transforms",
"pages": [
"geneva/jobs/lifecycle",
"geneva/jobs/backfilling",
"geneva/jobs/conflicts",
"geneva/jobs/materialized-views",
"geneva/jobs/performance",
"geneva/jobs/job_metrics",
"geneva/jobs/troubleshooting"
"geneva/udfs/providers/index",
"geneva/udfs/providers/openai",
"geneva/udfs/providers/gemini",
"geneva/udfs/providers/sentence-transformers"
]
},
{
"group": "Operations",
"group": "Running Jobs",
"pages": [
"geneva/jobs/contexts",
"geneva/deployment/dependency-verification",
"geneva/jobs/startup",
"geneva/jobs/console"
"geneva/jobs/backfilling",
"geneva/jobs/materialized-views",
"geneva/jobs/lifecycle",
"geneva/jobs/conflicts",
"geneva/jobs/performance",
"geneva/jobs/job_metrics",
"geneva/jobs/console",
"geneva/jobs/troubleshooting"
]
},
{
"group": "Deployment",
"pages": [
"geneva/deployment/index",
"geneva/deployment/helm",
"geneva/jobs/startup",
"geneva/deployment/dependency-verification",
"geneva/udfs/advanced-configuration",
"geneva/deployment/troubleshooting"
]
},
Expand Down
6 changes: 3 additions & 3 deletions docs/geneva/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ Feature Engineering and the `geneva` Python package are currently only available
in scaling up your feature engineering workloads for your AI and multimodal use cases.
</Card>

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

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

- **Overview**: [What is Feature Engineering?](/geneva/overview/)
- **UDFs**: [Using UDFs](/geneva/udfs/) · [Blob helpers](/geneva/udfs/blobs/) · [Error handling](/geneva/udfs/error_handling) · [Advanced configuration](/geneva/udfs/advanced-configuration)
- **UDFs**: [Using UDFs](/geneva/udfs/udfs) · [Blob helpers](/geneva/udfs/blobs/) · [Error handling](/geneva/udfs/error_handling) · [Advanced configuration](/geneva/udfs/advanced-configuration)
- **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/)
- **Deployment**: [Deployment overview](/geneva/deployment/) · [Helm deployment](/geneva/deployment/helm/) · [Troubleshooting](/geneva/deployment/troubleshooting/)
Loading
Loading