Add error handling docs #87
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jmhsieh
approved these changes
Jan 20, 2026
docs/geneva/udfs/index.mdx
Outdated
| `checkpoint_size` controls how many rows are processed before checkpointing, and therefore reporting and saving progress. | ||
|
|
||
| In LanceDB, the default number of rows per fragment is 1024 * 1024 rows. Conside a captioning UDF that takes 30s per row. It could take a year (!) before any results show up! (e.g. 30s/row * 1024*1024 rows/fragment => 30M s/fragment => 8.3k hours/fragment -> 347 days/fragment). To enable these to be parallelized, we provide a `batch_size` setting so the work can be split between workers and so that that partial results are checkpointed more frequently to enable finer-grained progress and job recovery. | ||
| By default, Geneva uses adaptive checkpoint sizing, so you don't need to set this parameter. This is because UDFs can be quite varied -- some can be simple operations where thousands of calls can be completed per second, while others may be slow and require 30s per row. So a simple default like "write every 1000 rows" might write once a second or once every 8 hours! Geneva will avoid this by adapting its checkpointing rate to your task. But if you want to see writes more or less frequently, you can set `checkpoint_size` manually. |
There was a problem hiding this comment.
I've been having some issues with this feature, we might want to mark the adaptive checkpoitn sizing as experiemental for now.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds docs from geneva internal docs about error handling. These looked pretty good already; I only tweaked a couple things to make them sound a little bit less AI, and adjusted the hierarchy to make it clear that there are 3 levels of complexity you can use to customize your error handling.
Touched up the main UDF page too.