docs: show full model names in Supported_Models.ipynb#653
Conversation
pd.DataFrame's default display.max_colwidth (50) truncates long model names like sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2 to an ellipsis, both in the rendered docs table (mknotebooks renders this notebook's stored outputs statically, execute: false) and when running the documented list_supported_models() snippet directly. Set display.max_colwidth to None before rendering the tables and re-execute the notebook so the baked-in outputs show full names. Fixes qdrant#632
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
📝 WalkthroughWalkthroughUpdated the supported-models notebook with refreshed execution metadata and rendered tables for text, sparse, late-interaction, image, and rerank models. Added full-width dataframe descriptions and the Estimated code review effort: 3 (Moderate) | ~20 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/examples/Supported_Models.ipynb (1)
1130-1136: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueRemove stray trailing empty cell.
A new, empty, unexecuted code cell was added at the end of the notebook. This looks like a leftover editing artifact rather than an intentional addition.
♻️ Suggested cleanup
- }, - { - "cell_type": "code", - "execution_count": null, - "metadata": {}, - "outputs": [], - "source": [] }🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/examples/Supported_Models.ipynb` around lines 1130 - 1136, Remove the stray trailing empty code cell from the Supported_Models notebook, leaving the preceding content and notebook structure unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@docs/examples/Supported_Models.ipynb`:
- Around line 1130-1136: Remove the stray trailing empty code cell from the
Supported_Models notebook, leaving the preceding content and notebook structure
unchanged.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 0755b1e7-2fc4-45f8-bcc2-3f1fd22e0188
📒 Files selected for processing (1)
docs/examples/Supported_Models.ipynb
Summary
pandas' defaultdisplay.max_colwidth(50) truncates long model names —e.g.
sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2— to anellipsis. This shows up in two places: the rendered docs table at
qdrant.github.io/fastembed/examples/Supported_Models (mknotebooks renders this
notebook's stored outputs statically —
execute: falseinmkdocs.yml, sowhatever is baked into the
.ipynbis what ships), and when running thedocumented
list_supported_models()snippet directly.We hit this ourselves:
paraphrase-multilingual-MiniLM-L12-v2is the model ourTextEmbeddingpipeline runs in production, and the truncation makes the twoparaphrase-multilingual-*variants indistinguishable from the table alone.Fix
One line in
docs/examples/Supported_Models.ipynb: setpd.set_option("display.max_colwidth", None)after the existing imports, thenre-execute the notebook so its stored outputs (both
text/plainandtext/html) show full names. Nofastembed/source touched.Validation
documented script verbatim.
jupyter nbconvert --execute --inplace);list_supported_models()is static metadata, no network needed....ellipsis remains in any output cell (TextEmbedding,SparseTextEmbedding,LateInteractionTextEmbedding,ImageEmbedding,TextCrossEncoder).ruff check/ruff format --checkon the notebook: clean (pre-commitcovers
.ipynbviatypes_or: [python, pyi, jupyter]).pytest --collect-onlyidentical between this branch andmain, andpytest tests/test_common.pypasses on both — expected, since no file underfastembed/ortests/changes.Note
Re-executing also refreshed rows missing from the previously-committed (stale)
outputs — the model catalog had grown since the notebook was last run. Same as
the last PR to touch this file (#393): touching this notebook means re-running
it, and re-running reflects whatever
maincurrently supports.#637 targets the same issue but appears inactive since May (draft, no review);
happy to defer to it or close this in its favor if its author is still on it —
whichever the maintainers prefer.
A natural follow-up would be rendering these tables from live metadata (or CSS
wrapping in the docs) so the page can't drift as models are added — out of
scope for this docs fix.