Skip to content

docs: add retriever docs#1407

Draft
akoumpa wants to merge 4 commits intomainfrom
akoumparouli/docs_add_retriever
Draft

docs: add retriever docs#1407
akoumpa wants to merge 4 commits intomainfrom
akoumparouli/docs_add_retriever

Conversation

@akoumpa
Copy link
Copy Markdown
Contributor

@akoumpa akoumpa commented Feb 27, 2026

What does this PR do ?

Add a one line overview of what this PR aims to accomplish.

Changelog

  • Add specific line by line info of high level changes in this PR.

Before your PR is "Ready for review"

Pre checks:

  • Make sure you read and followed Contributor guidelines
  • Did you write any new necessary tests?
  • Did you add or update any necessary documentation?

If you haven't finished some of the above items you can still open "Draft" PR.

Additional Information

  • Related to # (issue)

Signed-off-by: Alexandros Koumparoulis <akoumparouli@nvidia.com>
@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented Feb 27, 2026

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@akoumpa akoumpa added the docs-only With great power comes great responsibility. label Mar 3, 2026
akoumpa added 2 commits March 3, 2026 11:30
Signed-off-by: Alexandros Koumparoulis <akoumparouli@nvidia.com>
Signed-off-by: Alexandros Koumparoulis <akoumparouli@nvidia.com>
@akoumpa
Copy link
Copy Markdown
Contributor Author

akoumpa commented Mar 4, 2026

/ok to test 0346ed6

@akoumpa akoumpa marked this pull request as ready for review March 4, 2026 18:08
@akoumpa akoumpa enabled auto-merge (squash) March 4, 2026 18:08
@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented Mar 4, 2026

/ok to test 0346ed6

@akoumpa, there was an error processing your request: E2

See the following link for more information: https://docs.gha-runners.nvidia.com/cpr/e/2/

INFO:root:step 30 | epoch 0 | val_loss 1.1230 | val_acc1 0.7820 | val_mrr 0.8450
```

## Using the Fine-Tuned Model
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

better to change this to transformers usage script. as in here:

https://huggingface.co/nvidia/llama-nemotron-embed-1b-v2#transformers-usage

dataset:
_target_: nemo_automodel.components.datasets.llm.make_retrieval_dataset
data_dir_list:
- /path/to/train_data.json
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

here better to use the predefined path that we added lately to automatically download the example dataset from HF hub.

see the latest yaml file pls: https://github.com/NVIDIA-NeMo/Automodel/blob/main/examples/biencoder/llama3_2_1b_biencoder.yaml#L55


```yaml
model:
_target_: nemo_automodel.NeMoAutoModelBiencoder.from_pretrained
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

let's not merge this MR yet, we can do once MR 1449 is finalized, we might need to update class names etc.

Copy link
Copy Markdown
Contributor

@jgerh jgerh left a comment

Choose a reason for hiding this comment

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

Completed tech pubs review of docs/guides/overview.md and docs/guides/retriever/embedding-finetuning.md and provided a few copyedits. docs/index.md reviewed in #1573.

Comment thread docs/guides/retriever/embedding-finetuning.md Outdated
Comment thread docs/guides/retriever/embedding-finetuning.md Outdated
Comment thread docs/guides/retriever/embedding-finetuning.md Outdated
Comment thread docs/guides/retriever/embedding-finetuning.md Outdated
Comment thread docs/guides/overview.md Outdated
Comment thread docs/guides/overview.md
Comment thread docs/guides/overview.md
Comment thread docs/guides/overview.md
@akoumpa akoumpa marked this pull request as draft March 18, 2026 18:50
auto-merge was automatically disabled March 18, 2026 18:50

Pull request was converted to draft

Co-authored-by: jgerh <163925524+jgerh@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-only With great power comes great responsibility.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants