Generated banner for Nemo Rl Docs
Generated logo for Nemo Rl Docs

Nemo Rl Docs

NVIDIAOfficialPublished by NVIDIA

  • Skill
  • Guidelines
  • Documents and content
  • Apache-2.0
  • Medium risk

From the author

Documentation conventions for NeMo-RL. Covers docs/index.md updates and docstring format. Do NOT use for: bug fixes, test fixes, dependency bumps, refactoring, CI/CD changes, performance tuning, or any task that does not involve writing or updating documentation.
— the description by NVIDIA

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill provides the established guidelines for maintaining documentation within the NeMo-RL project. It outlines the requirements for updating the central index file when new documentation is added and specifies the use of Google-style docstrings to ensure compatibility with Sphinx documentation generation.

What it does

  • Defines the structure for updating the project index file.
  • Mandates Google-style docstrings for classes and functions.
  • Provides guidance on where to place new documentation files.
  • Distinguishes between appropriate use of docstrings versus internal code comments.

When to use it

  • When adding or updating project documentation.
  • When creating new markdown files within the documentation directory.
  • When reviewing or writing docstrings for public interfaces.
  • When determining the correct location for new feature documentation.

Advantages

  • Ensures consistent documentation structure across the project.
  • Facilitates automated documentation generation via Sphinx.
  • Improves readability and maintainability of public-facing code interfaces.

Usage examples

“How should I format my function docstrings?”
The agent will advise using Google-style docstrings to ensure they are correctly parsed by Sphinx.
“Where do I register a new documentation file?”
The agent will instruct you to update the docs/index.md file and place the new file in the appropriate section.

Install

  1. Download the skill as a ZIP:

    https://autogineer.com/agent-skills/nvidia/nemo-rl-docs/download
  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip nemo-rl-docs.zip -d .agents/skills

Documentation by NVIDIA

Documentation Conventions

Keep docs/index.md Up to Date

When a new markdown doc is added under docs/**/*.md or a markdown file is renamed, ensure that @docs/index.md is updated and the document appears in the most appropriate section.

Docstring Format

Use Google style docstrings for classes and functions. These are parseable by Sphinx.

For interfaces that may be used outside a file, prefer docstrings over comments. Comments should be reserved for code within a function or interfaces local to a file.

Document New Features

When a new feature is added, update or create documentation in the docs/ directory that most closely matches the feature. Look at existing docs to find the best fit — if none exists, create a new doc and add it to @docs/index.md.

Documentation changes are not required for bug fixes or CI-related changes.

Files

BENCHMARK.md

Evaluation Report

Evaluation of the nemo-rl-docs skill before publication through NVSkills-Eval.

This benchmark summarizes 3-Tier Evaluation from NVSkills-Eval results for the skill. The goal is to document whether the skill is safe, discoverable, effective, and useful for agents before it is published for broader workflow use.

Evaluation Summary

  • Skill: nemo-rl-docs

  • Evaluation date: 2026-06-01

  • NVSkills-Eval profile: external

  • Environment: local

  • Dataset: 5 evaluation tasks

  • Attempts per task: 2

  • Pass threshold: 50%

  • Overall verdict: PASS

Agents Used

  • claude-code

  • codex

Metrics Used

Reported benchmark dimensions:

  • Security: checks whether skill-assisted execution avoids unsafe behavior such as secret leakage, destructive commands, or unauthorized access.

  • Correctness: checks whether the agent follows the expected workflow and produces the correct final output.

  • Discoverability: checks whether the agent loads the skill when relevant and avoids using it when irrelevant.

  • Effectiveness: checks whether the agent performs measurably better with the skill than without it.

  • Efficiency: checks whether the agent uses fewer tokens and avoids redundant work.

Underlying evaluation signals used in this run:

  • security (Security): checks for unsafe operations, secret leakage, and unauthorized access.

  • skill_execution (Skill Execution): verifies that the agent loaded the expected skill and workflow.

  • skill_efficiency (Efficiency): checks routing quality, decoy avoidance, and redundant tool usage.

  • accuracy (Accuracy): grades final-answer correctness against the reference answer.

  • goal_accuracy (Goal Accuracy): checks whether the overall user task completed successfully.

  • behavior_check (Behavior Check): verifies expected behavior steps, including safety expectations.

  • token_efficiency (Token Efficiency): compares token usage with and without the skill.

Test Tasks

The benchmark dataset contained 5 evaluation tasks:

  • Positive tasks: 3 tasks where the skill was expected to activate.

  • Negative tasks: 2 tasks where no skill was expected.

  • Unlabeled tasks: 0 tasks where positive/negative intent could not be inferred.

Task composition is derived from the evaluation dataset when possible. Entries with expected_skill set are treated as positive skill-activation cases, while entries with expected_skill: null are treated as negative activation cases.

Results

DimensionNumclaude-codecodex
Security8100% (+0%)100% (+0%)
Correctness891% (+7%)83% (+11%)
Discoverability899% (-1%)90% (+5%)
Effectiveness881% (+8%)80% (+18%)
Efficiency885% (-0%)79% (+3%)

Score values show skill-assisted performance. Values in parentheses show uplift versus the no-skill baseline when baseline data is available.

Tier 1: Static Validation Summary

Tier 1 validation passed with observations. NVSkills-Eval ran 9 checks and found 13 total findings.

Top findings:

  • MEDIUM QUALITY/quality_correctness: Guide-only skill has very little content (15 lines) (skills/nemo-rl-docs/SKILL.md)

  • MEDIUM QUALITY/quality_correctness: SKILL_SPEC recommended field missing: 'metadata.author' (skills/nemo-rl-docs/SKILL.md)

  • MEDIUM QUALITY/quality_correctness: SKILL_SPEC recommended field missing: 'metadata.tags' (skills/nemo-rl-docs/SKILL.md)

  • MEDIUM SCHEMA/body_recommended_section: Missing recommended section: '## Instructions' (skills/nemo-rl-docs/SKILL.md)

  • MEDIUM SCHEMA/body_recommended_section: Missing recommended section: '## Examples' (skills/nemo-rl-docs/SKILL.md)

Tier 2: Deduplication Summary

Tier 2 validation passed. NVSkills-Eval ran 2 checks and found 0 total findings.

Notable observations:

  • Context Deduplication: Collected 1 file(s)

  • Inter-Skill Deduplication: Parsed skill 'nemo-rl-docs': 263 char description

Publication Recommendation

The skill is suitable to proceed toward NVSkills-Eval publication based on this benchmark. Skill owners should keep this file with the skill and refresh it when the evaluation dataset, skill behavior, or target agents materially change.

Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Security

What our scanner noticed· Medium risk

  • Large base64-encoded blobs

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Published by
NVIDIA
Publisher
NVIDIA (Official)
Source
NVIDIA/skills · skills/nemo-rl-docs · commit fce3cca
Licence
Apache License 2.0 (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE-APACHE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by NVIDIA or NVIDIA.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download nemo-rl-docs.zip