NVIDIA / NVIDIA/nvcf

Publish the ModelExpress guide and discovery links

Open
#1,348 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
218
Forks
72
Avg merge
1d 12h
Merged PRs (30d)
427

Description

Description

Add the public ModelExpress guide for self-managed compute planes and register it
in both discovery locations.

This covers the parts that do not depend on measured results. Scale-out results,
verification evidence, and fabric validation arrive in the follow-up
documentation task.

Definition of Done

  • The guide explains when peer-to-peer weight distribution helps and when it does
    not, so readers can decide whether to enable it.
  • Supported versions, worker image contents, NIXL and RDMA requirements, RBAC,
    secrets, and provider-specific network settings are explicit.
  • Prerequisites, configuration, rollout, and cleanup are covered.
  • The guide states that ModelExpress is optional, opt-in, and installed outside
    the compute-plane stack.
  • The page is registered in fern/versions/dev.yml and linked from
    docs/user/optional-enhancements.md in the same change.
  • Content changes are confined to docs/user, plus the navigation entry in
    fern/versions/dev.yml noted above. The frozen docs/v0.5, docs/v0.6.0, and
    docs/v0.6.1 trees are unchanged.
  • tools/ci/check-docs and fern check pass.

Resources

Related documentation request: #108
Comparable page: docs/user/cluster-management/container-cache.md

The guide deliberately carries no benchmark numbers. Measured figures depend on
model size, hub, fabric, and worker count, and a number quoted without those
conditions is misleading. The guide instead states the conditions that decide the
outcome and tells readers how to measure their own.

Part of #1113.

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.

Research direction

Start with docs/user/cluster-management/container-cache.md and docs/user/optional-enhancements.md, then inspect fern/versions/dev.yml for navigation conventions. Add the ModelExpress guide under docs/user, link and register it, and run tools/ci/check-docs and fern check; done means the listed prerequisites, configuration, rollout, cleanup, and opt-in boundaries are documented without benchmark claims.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
3-5 days
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.