Skip to content

docs(linalg): document the argmin/argmax optional-value kernels - #9124

Open
fightBoxing wants to merge 1 commit into
lance-format:mainfrom
fightBoxing:docs/linalg-argmin-docs
Open

fightBoxing wants to merge 1 commit into
lance-format:mainfrom
fightBoxing:docs/linalg-argmin-docs

Conversation

@fightBoxing

Copy link
Copy Markdown

Summary

  • Document the three public argmin/argmax kernels in lance-linalg that lacked rustdoc: argmax_opt, argmin_value_opt, and argmin_value_float_with_bias.
  • Document the bias semantics of argmin_value_float_with_bias: the comparison uses value + bias but the returned value is the original value without the bias term; passing None for bias falls back to argmin_value_float.

Validation

  • cargo test -p lance-linalg
  • cargo doc -p lance-linalg --no-deps
  • cargo fmt --all
  • cargo clippy -p lance-linalg --tests -- -D warnings

@github-actions github-actions Bot added A-index Vector index, linalg, tokenizer documentation Improvements or additions to documentation labels Sep 10, 2026

@lance-gatekeeper lance-gatekeeper Bot 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.

Gate recommendation: approve.

The rustdoc matches the kernels’ actual boundary behavior, including skipped None values, strict comparisons against the numeric bounds, zip truncation, and biased selection returning the original unbiased value. This is the smallest appropriate change for the documentation gap.

@lance-gatekeeper lance-gatekeeper Bot added the K-approved Latest Gatekeeper recommendation permits acceptance. label Sep 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-index Vector index, linalg, tokenizer documentation Improvements or additions to documentation K-approved Latest Gatekeeper recommendation permits acceptance.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant