Skip to content

docs: show full model names in Supported_Models.ipynb#653

Open
Yyunozor wants to merge 1 commit into
qdrant:mainfrom
Yyunozor:docs/show-full-model-names-in-supported-models
Open

docs: show full model names in Supported_Models.ipynb#653
Yyunozor wants to merge 1 commit into
qdrant:mainfrom
Yyunozor:docs/show-full-model-names-in-supported-models

Conversation

@Yyunozor

Copy link
Copy Markdown

Summary

pandas' default display.max_colwidth (50) truncates long model names —
e.g. sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2 — to an
ellipsis. 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: false in mkdocs.yml, so
whatever is baked into the .ipynb is what ships), and when running the
documented list_supported_models() snippet directly.

We hit this ourselves: paraphrase-multilingual-MiniLM-L12-v2 is the model our
TextEmbedding pipeline runs in production, and the truncation makes the two
paraphrase-multilingual-* variants indistinguishable from the table alone.

Fix

One line in docs/examples/Supported_Models.ipynb: set
pd.set_option("display.max_colwidth", None) after the existing imports, then
re-execute the notebook so its stored outputs (both text/plain and
text/html) show full names. No fastembed/ source touched.

Validation

  • Reproduced the exact truncation from the issue on a fresh venv running the
    documented script verbatim.
  • Re-executed the notebook (jupyter nbconvert --execute --inplace);
    list_supported_models() is static metadata, no network needed.
  • Confirmed no ... ellipsis remains in any output cell (TextEmbedding,
    SparseTextEmbedding, LateInteractionTextEmbedding, ImageEmbedding,
    TextCrossEncoder).
  • ruff check / ruff format --check on the notebook: clean (pre-commit
    covers .ipynb via types_or: [python, pyi, jupyter]).
  • pytest --collect-only identical between this branch and main, and
    pytest tests/test_common.py passes on both — expected, since no file under
    fastembed/ or tests/ 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 main currently 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.

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
@review-notebook-app

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@coderabbitai

coderabbitai Bot commented Jul 22, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Updated 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 TextCrossEncoder import. Outputs now include expanded metadata columns and current model values. Notebook metadata was updated from version 3.11.8 to 3.12.0.

Estimated code review effort: 3 (Moderate) | ~20 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly states the main change: showing full model names in the Supported_Models notebook.
Description check ✅ Passed The description accurately matches the notebook update and explains the truncation fix and re-execution of outputs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
docs/examples/Supported_Models.ipynb (1)

1130-1136: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Remove 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

📥 Commits

Reviewing files that changed from the base of the PR and between 0892291 and e47576e.

📒 Files selected for processing (1)
  • docs/examples/Supported_Models.ipynb

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