NVIDIA-Merlin / NVIDIA-Merlin/Merlin

[RMP] Revamp Merlin "Getting Started" Documentation

Open
#1,021 0 comments 0 reactions 2 assignees View on GitHub

@nv-alaiacano is already working on this.

Since Jun 27, 2023.

Dominant language
Python
Stars
907
Forks
129
PR merge metrics
No merged PRs in 30d

Description

The goal of this RMP is to revamp the "Getting Started" section of our Merlin documentation.

The introductory tutorials are meant to cover a limited number of things:

  • Introduce Merlin-specific syntax
  • Show how to perform common recsys tasks (train well-known model types) in Merlin
  • Introduce the concept of Systems with a basic example.
  • #1033
  • Installation guide: Docker, Conda, Pip, Launchpad, Google Colab @bschifferer
  • New tutorials with some "basics"
    • The >> operator, NVTabular workflow, Graph, fit/transform.
    • Training a ranking model: NVT + DLRM (or similar)
    • Training a retrieval model: NVT + TT (or similar)
    • Creating a basic System: Fetch Features -> NVT -> Ranking -> SampleSoftmax. (Since there's no retrieval model, input can be something like {user_id: u, item_ids: [a, b, c, d]}) @nv-alaiacano

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.