Skip to content

docs: refresh embedder configuration user guide#289

Merged
voorhs merged 2 commits into
devfrom
docs/embedder-guide
May 19, 2026
Merged

docs: refresh embedder configuration user guide#289
voorhs merged 2 commits into
devfrom
docs/embedder-guide

Conversation

@voorhs
Copy link
Copy Markdown
Collaborator

@voorhs voorhs commented May 19, 2026

Summary

  • Extends user_guides/advanced/02_embedder_configuration.py for OpenAI, vLLM, and HashingVectorizer backends.
  • Adds embedder fine-tuning section (EmbedderFineTuningConfig, Embedder.train, RetrievalAimedEmbedding).
  • Updates troubleshooting (removes outdated fp16 “planned” note).

Test plan

  • Examples match configs/_embedder.py and embedder API
  • Notebook builds via docs pipeline if applicable

Part of the v0.3.0 documentation pass (independent of other PRs).

Made with Cursor

voorhs and others added 2 commits May 19, 2026 20:34
Document all embed backends, extras, OpenAI batching, vLLM and hashing
options, and Sentence Transformer-only fine-tuning via Embedder.train
and RetrievalAimedEmbedding.ft_config; align mixed-precision notes with
current config support.

Co-authored-by: Cursor <cursoragent@cursor.com>
@voorhs voorhs merged commit a5098ee into dev May 19, 2026
60 checks passed
@voorhs voorhs deleted the docs/embedder-guide branch May 19, 2026 20:37
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.

1 participant