config-conventions

What problem does it solve?

It prevents hidden or inconsistent configuration defaults in NeMo-RL by making YAML the single source of truth and enforcing clear rules around required fields, optional fields, and documented exemplar values.

Core Features & Use Cases

• YAML-first defaults: Stops developers from hardcoding non-None defaults in code so runtime behavior is explicit and user-controlled.
• TypedDict optionality: Guides correct handling of NotRequired fields so absence is treated as meaningful rather than masked by magic fallback values.
• Exemplar-driven documentation: Ensures exemplar YAMLs define defaults, while recipe YAMLs remain minimal by inheriting via a required defaults pointer.
• Forbidden patterns guardrails: Flags common ways defaults leak into code (e.g., get(..., "bfloat16") or function parameters defaulting config values), improving review quality.

Quick Start

Follow the rules in this skill while editing NeMo-RL TypedDict config structures and exemplar/recipe YAMLs, then use minimize on any recipe YAML missing the required defaults key.