NVIDIA-Merlin / NVIDIA-Merlin/Merlin

[INF]Documentation improvement

Open
#867 1 comment 0 reactions 1 assignee View on GitHub

@EvenOldridge is already working on this.

Since Mar 28, 2023.

documentation roadmap
Dominant language
Python
Stars
907
Forks
129
No merged PRs in 30d

Description

Description

We want to focus on improving our documentations.

We brainstormed / collected following ideas (not prioritised, yet):

General

  • Merlin Overview Page
  • Installation
  • Schema File and Definition
  • Merlin DAG
  • Session-based Tensorflow API
  • Negative sampling strategy api documentation
  • migration guide from Transformers4Rec to Merlin Models Transformer API
  • Examples by industry(retail/Finance/M&E)
  • Examples by use cases (homepage carousel/item2item/etc.)
  • Best practices for enterprise customers

quick start example documentation

How to write an operator

  • NVTabular
  • Merlin Systems

Inline Documentation (Coverage)

Docstring Coverage (March 28th):

  • Merlin Models: 40%
  • Transformers4Rec: 41%
  • Merlin Systems: 80%
  • Merlin Core: 80%
  • DataLoader: 78%

Some previous attempts:
https://github.com/NVIDIA-Merlin/Merlin/issues/788
https://github.com/NVIDIA-Merlin/Merlin/issues/795
https://github.com/NVIDIA-Merlin/Merlin/issues/794

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.