Update transformers and sentence transformers docs by BenWilson2 · Pull Request #18925 · mlflow/mlflow

BenWilson2 · 2025-11-19T16:23:33Z

🛠 DevTools 🛠

Install mlflow from this PR

# mlflow
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/18925/merge
# mlflow-skinny
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/18925/merge#subdirectory=libs/skinny

For Databricks, use the following command:

%sh curl -LsSf https://raw.githubusercontent.com/mlflow/mlflow/HEAD/dev/install-skinny.sh | sh -s pull/18925/merge

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Standardize and cleanup junk marketing fluff from transformers / sentence transformers docs.

How is this PR tested?

Existing unit/integration tests
New unit/integration tests
Manual tests

Does this PR require documentation update?

Release Notes

Is this a user-facing change?

No. You can skip the rest of this section.
Yes. Give a description of this change to be included in the release notes for MLflow users.

What component(s), interfaces, languages, and integrations does this PR affect?

Components

How should the PR be classified in the release notes? Choose one:

rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section
rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
rn/feature - A new user-facing feature worth mentioning in the release notes
rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
rn/documentation - A user-facing documentation change worth mentioning in the release notes

Should this PR be included in the next patch release?

Yes should be selected for bug fixes, documentation updates, and other small changes. No should be selected for new features and larger changes. If you're unsure about the release classification of this PR, leave this unchecked to let the maintainers decide.

What is a minor/patch release?

Minor release: a release that increments the second part of the version number (e.g., 1.2.0 -> 1.3.0).
Bug fixes, doc updates and new features usually go into minor releases.
Patch release: a release that increments the third part of the version number (e.g., 1.2.0 -> 1.2.1).
Bug fixes and doc updates usually go into patch releases.

Yes (this PR will be cherry-picked and included in the next patch release)
No (this PR will be included in the next minor release)

Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>

github-actions · 2025-11-19T16:37:36Z

Documentation preview for 1136158 is available at:

https://pr-18925--mlflow-docs-preview.netlify.app/docs/latest/

Changed Pages (5)

ml/deep-learning/sentence-transformers (modified)
ml/deep-learning/sentence-transformers/guide (removed, ✅ redirect exists)
ml/deep-learning/sentence-transformers/tutorials (removed, ✅ redirect exists)
ml/deep-learning/transformers (modified)
ml/deep-learning/transformers/guide (modified)

More info

Ignore this comment if this PR does not change the documentation.
The preview is updated when a new commit is pushed to this PR.
This comment was created by this workflow run.
The documentation was built by this workflow run.

Copilot

Pull Request Overview

This pull request standardizes and cleans up the Transformers and Sentence Transformers documentation by removing marketing language, consolidating pages, and providing more focused, practical examples.

Key Changes

Simplified navigation structure by consolidating Sentence Transformers guides and tutorials into a single page
Rewrote documentation to be more concise and focused on practical usage
Removed version-specific notes that are no longer relevant
Updated redirects to maintain backward compatibility with old URLs

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
docs/sidebarsClassicML.ts	Simplified Sentence Transformers navigation from category to single doc
docs/docusaurus.config.ts	Updated redirects for consolidated Sentence Transformers pages
docs/docs/classic-ml/deep-learning/transformers/index.mdx	Cleaned up marketing language, added structured sections with clearer examples
docs/docs/classic-ml/deep-learning/transformers/guide/index.mdx	Removed outdated version-specific notes
docs/docs/classic-ml/deep-learning/sentence-transformers/index.mdx	Complete rewrite with practical examples and consolidated content
docs/docs/classic-ml/deep-learning/sentence-transformers/guide/index.mdx	Removed (content consolidated into main page)
docs/docs/classic-ml/deep-learning/sentence-transformers/tutorials/index.mdx	Removed (content consolidated into main page)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-19T17:52:01Z

docs/docs/classic-ml/deep-learning/sentence-transformers/index.mdx

- 🔍 Build advanced semantic search systems with re-ranking and relevance optimization
- 📦 Create custom model flavors for specialized architectures and deployment requirements
- 🎨 Develop comprehensive evaluation frameworks for semantic quality assessment
+```python


Missing import statements. The code block uses mlflow and SentenceTransformer but doesn't import them. For a standalone example, it should include: import mlflow and from sentence_transformers import SentenceTransformer before the import time statement.

Suggested change

```python

```python

import mlflow

from sentence_transformers import SentenceTransformer

Copilot · 2025-11-19T17:52:02Z

docs/docs/classic-ml/deep-learning/sentence-transformers/index.mdx

 ```python
-# Fine-tune for your domain
-from sentence_transformers import SentenceTransformer, InputExample, losses
+from sentence_transformers import InputExample, losses


Missing import statements. The code block uses mlflow and SentenceTransformer but doesn't import them. For a standalone example, it should include: import mlflow and from sentence_transformers import SentenceTransformer.

Suggested change

from sentence_transformers import InputExample, losses

import mlflow

from sentence_transformers import SentenceTransformer, InputExample, losses

Copilot · 2025-11-19T17:52:02Z

docs/docs/classic-ml/deep-learning/sentence-transformers/index.mdx

+```python
+models_to_compare = [
+    "all-MiniLM-L6-v2",
+    "all-mpnet-base-v2",
+    "paraphrase-albert-small-v2",
+]


Missing import statements. The code block uses mlflow, SentenceTransformer, pd (pandas), and time but doesn't import them. For a standalone example, it should include all necessary imports: import mlflow, import pandas as pd, import time, and from sentence_transformers import SentenceTransformer.

Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>

Copilot

Pull request overview

Copilot reviewed 7 out of 9 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.

B-Step62 · 2025-12-03T01:57:32Z

docs/docs/classic-ml/deep-learning/sentence-transformers/index.mdx

+      icon: Zap,
+      title: "Autologging",
+      description: "Automatic tracking of training metrics and parameters",
+    },


I think we don't support autologging?

Perhaps our trainer logger for transformers may work, but then can we have a guide for that in that page.

B-Step62 · 2025-12-03T02:00:30Z

docs/docs/classic-ml/deep-learning/sentence-transformers/index.mdx

- 🧬 **Scientific Literature Analysis**: Analyze research papers, patents, and technical documents for similarity, trends, and knowledge gaps
-
-## Complete Learning Journey
+## Batch Processing


Do we need this example? This doesn't seem to be using any special mlflow feature.

Yep will delete

B-Step62 · 2025-12-03T02:01:35Z

docs/docs/classic-ml/deep-learning/sentence-transformers/index.mdx

+```

-</details>
+## Model Comparison


If we want to show comparison use case, I guess we should use eval? (or maybe can just remove)

Yeah I'm just going to remove it.

B-Step62 · 2025-12-03T02:08:14Z

docs/docs/classic-ml/deep-learning/transformers/guide/index.mdx

@@ -202,10 +202,6 @@ print(response)

 ## Saving Prompt Templates with Transformer Pipelines


Can we actually remove this guide? We should now recommend prompt registry rather than logging it directly in the model.

B-Step62 · 2025-12-03T02:11:14Z

docs/docs/classic-ml/deep-learning/sentence-transformers/index.mdx

+<CardGroup>
+  <PageCard
+    headerText="Sentence Transformers Quickstart"
+    link="/ml/deep-learning/sentence-transformers/tutorials/quickstart/sentence-transformers-quickstart/"


Let's add these tutorial pages in the sidebar

B-Step62 · 2025-12-03T02:11:51Z

docs/docs/classic-ml/deep-learning/transformers/index.mdx

-tracking to model deployment. This combination offers a robust and efficient pathway for incorporating advanced NLP and AI capabilities
-into your applications.
+```bash
+pip install mlflow[transformers]


Suggested change

pip install mlflow[transformers]

pip install mlflow transformers

B-Step62 · 2025-12-03T02:13:52Z

docs/docs/classic-ml/deep-learning/transformers/index.mdx

Thoughts on adding a quick section about report_to="mlflow" in the transformers library as autologging feature?

good call! Will add

B-Step62

Overall LGTM but left a few comments to be addressed before merging

Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>

Update transformers and sentence transformers docs

d705442

Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>

github-actions bot added area/docs Documentation issues rn/documentation Mention under Documentation Changes in Changelogs. v3.6.1 labels Nov 19, 2025

BenWilson2 added the team-review Trigger a team review request label Nov 19, 2025

github-actions bot requested review from B-Step62, TomeHirata, WeichenXu123, daniellok-db, harupy, kevin-lyn, serena-ruan and xq-yin November 19, 2025 17:47

BenWilson2 requested review from Copilot and removed request for B-Step62, TomeHirata, WeichenXu123, daniellok-db, harupy, kevin-lyn, serena-ruan and xq-yin November 19, 2025 17:47

Copilot started reviewing on behalf of BenWilson2 November 19, 2025 17:47 View session

Copilot finished reviewing on behalf of BenWilson2 November 19, 2025 17:50

Copilot AI reviewed Nov 19, 2025

View reviewed changes

BenWilson2 added 2 commits November 19, 2025 15:12

Merge branch 'master' into cleanup-transformers-docs

72afcf3

make code blocks importable

5a517f3

Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>

BenWilson2 added team-review Trigger a team review request and removed team-review Trigger a team review request labels Nov 20, 2025

github-actions bot requested review from B-Step62, TomeHirata, WeichenXu123, daniellok-db, harupy, kevin-lyn, serena-ruan and xq-yin November 20, 2025 14:40

BenWilson2 added 2 commits December 1, 2025 20:36

Merge branch 'master' into cleanup-transformers-docs

67203d7

Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>

lint

b1345b9

Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>

BenWilson2 added v3.7.0 and removed v3.6.1 labels Dec 2, 2025

BenWilson2 requested a review from Copilot December 2, 2025 04:05

Copilot started reviewing on behalf of BenWilson2 December 2, 2025 04:05 View session

Copilot finished reviewing on behalf of BenWilson2 December 2, 2025 04:07

Copilot AI reviewed Dec 2, 2025

View reviewed changes

B-Step62 reviewed Dec 3, 2025

View reviewed changes

B-Step62 approved these changes Dec 3, 2025

View reviewed changes

fixes

1136158

Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>

BenWilson2 added this pull request to the merge queue Dec 3, 2025

Merged via the queue into mlflow:master with commit a6f55d0 Dec 3, 2025
46 checks passed

BenWilson2 deleted the cleanup-transformers-docs branch December 3, 2025 14:33

BenWilson2 added a commit to BenWilson2/mlflow that referenced this pull request Dec 4, 2025

Update transformers and sentence transformers docs (mlflow#18925)

b56e515

Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>

BenWilson2 added a commit that referenced this pull request Dec 4, 2025

Update transformers and sentence transformers docs (#18925)

bf7bf87

Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>

	from sentence_transformers import InputExample, losses
	import mlflow
	from sentence_transformers import SentenceTransformer, InputExample, losses

		@@ -202,10 +202,6 @@ print(response)

		## Saving Prompt Templates with Transformer Pipelines

	pip install mlflow[transformers]
	pip install mlflow transformers

Conversation

BenWilson2 commented Nov 19, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Install mlflow from this PR

Related Issues/PRs

What changes are proposed in this pull request?

How is this PR tested?

Does this PR require documentation update?

Release Notes

Is this a user-facing change?

What component(s), interfaces, languages, and integrations does this PR affect?

How should the PR be classified in the release notes? Choose one:

Should this PR be included in the next patch release?

Uh oh!

github-actions bot commented Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Key Changes

Reviewed Changes

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

B-Step62 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

BenWilson2 commented Nov 19, 2025 •

edited by github-actions bot

Loading

github-actions bot commented Nov 19, 2025 •

edited

Loading