[RMP] Documentation for 1.0

[karlhigley]

Merlin:

• Identify standard high-level Merlin README headings #145
• Revise high-level docs for the new Merlin ecosystem (beyond NVT) #130
• docs: add a docs build #174

Core:

• Set up automated docs builds

Models:

• Update Models README for 22.04 models#285
• Set up automated doc builds
  • chore: add PR doc previews models#229
  • [REVIEW] docs: initial commit for Sphinx docs models#174)

NVTabular:

• README revisions?
  Note: There are some un related items in the readme such as container build process for other repos. Should this be cleaned ? There is documentaiton regarding examples for other repos. Should this be moved ?

Systems:

• Write a README (description of the library/API and instructions for how to use it) systems#4
• Set up automated docs builds

Transformers4Rec:

• Set up automated doc builds
  • chore: Add docs preview to PRs Transformers4Rec#382

HugeCTR

• Convert HCTR doc to sphinx keeping SOK as separate doc
• Note: Michael was able to resolve the issue. Will have SOK and HCTR under one Sphinx doc. Will have it for 22.04
• Make all our repos to have same headline (repo name) | (doc link)
• Note: Will have it for 22.04
• Centralized doc will follow next release
• Will target 22.05
  Individual repo doc updates
  Expecting inputs from engineering team. Michael to share updates on how it affects his other works

Support matrix

• Create One Support Matrix for Merlin

  • docs: add a docs build #174
  • Move Support Matrix Under Merlin Github Repo From NVT (22.04) #177
  • Change the title to ‘Merlin Support Matrix’
  • Update for all 6 containers
  • Place newer information first
  • Table per container
  • Page for each year is nice-to-have

• [ ]Support matrix - Combining tables to Training and Inference instead of 6 ( after 22.04)

  • Michael to draft POC and will review

Aha! Link: https://nvaiinfa.aha.io/features/MERLIN-822

[viswa-nvidia]

@mikemckiernan , please add all the tickets that you are working on for v1.0in the ticket here. If you need help adding these tickets please slack me

[mikemckiernan]

PR NVIDIA-Merlin/models#193 is meant to encompass issue NVIDIA-Merlin/models#192

[karlhigley]

I've added some check boxes for other docs related work I think is in scope (some of which I'm on the hook for, and some of which we'll want to figure out how to handle.)

[viswa-nvidia]

@EvenOldridge @benfred , do we need to revise the readme for NVTabular ?

[viswa-nvidia]

@EvenOldridge , @benfred @karlhigley @mikemckiernan - in NVTabular readme - There are some un related items in the readme such as container build process for other repos. Should this be cleaned ? There is documentaiton regarding examples for other repos. Should this be moved ?

[karlhigley]

Sounds like the HugeCTR work here is done, if I understood correctly from @mikemckiernan?

[EvenOldridge]

1.0 release is complete. Let's create a new docs ticket.