Skip to content

feat: enhance and fix README.md for embedding fine tuning tutorial #386

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Nov 4, 2025
Merged

feat: enhance and fix README.md for embedding fine tuning tutorial #386

merged 2 commits into from
Nov 4, 2025

Conversation

@ryan-lempka
Copy link
Collaborator

@ryan-lempka ryan-lempka commented Nov 4, 2025

This PR achieves:

  1. Fixed Links & Acronyms - Corrected SPECTER dataset link, defined NIM/SFT/BEIR on first use
  2. Added Motivation - New "Why Fine-tune?" section explaining retrieval's role in AI applications and NeMo's value proposition
  3. Clarified Objectives - Enhanced with baseline comparison approach and measurable outcomes
  4. Improved Dataset Section - Added concrete triplet example and explained contrastive learning objective
  5. Documented Setup - Added instructions for obtaining environment variables via /etc/hosts with Demo Cluster Setup link

@ryan-lempka ryan-lempka self-assigned this Nov 4, 2025
@ryan-lempka ryan-lempka requested a review from dglogo November 4, 2025 18:59
@ryan-lempka ryan-lempka removed the request for review from dglogo November 4, 2025 19:14
@dglogo dglogo merged commit e04f201 into NVIDIA:main Nov 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@shashank3959 shashank3959 shashank3959 approved these changes

@dglogo dglogo dglogo approved these changes

Assignees

@ryan-lempka ryan-lempka

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ryan-lempka @shashank3959 @dglogo