Agent skill

Document Public APIs

by pytorch in pytorch/pytorch

Document undocumented public APIs in PyTorch by removing functions from coverageignorefunctions and coverageignoreclasses in docs/source/conf.py, running Sphinx coverage, and adding the appropriate…

Custom licenceAuto-check passedAI & LLM Engineering

Install Document Public APIs

skills CLI
$ npx skills add pytorch/pytorch --skill document-public-apis -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install pytorch/pytorch document-public-apis --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/pytorch/pytorch.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/document-public-apis .claude/skills/document-public-apis && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
document-public-apis
GitHub stars
104k
Token cost
~4.2k tokens
SKILL.md length
1,814 words
Files
1
Skills in repo
16
Repo updated
First seen
Licence
Custom licence

At a glance

Document undocumented public APIs in PyTorch by removing functions from coverageignorefunctions and coverageignoreclasses in docs/source/conf.py, running Sphinx coverage, and adding the appropriate…

  • Works in 8 steps: Select module groups to document → Present the batch to the user → Comment out entries in conf.py → …
  • A user asks to remove functions from conf.py ignore lists
  • SKILL.md covers Overview, Instructions and Important notes
  • Calls make, python and pip

What it does

Document Public APIs is an agent skill from pytorch/pytorch. Document undocumented public APIs in PyTorch by removing functions from coverageignorefunctions and coverageignoreclasses in docs/source/conf.py, running Sphinx coverage, and adding the appropriate autodoc directives to the correct .md or .rst doc files. Use when a user asks to remove functions from conf.py ignore lists.

Its SKILL.md is about 4.2k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in AI & LLM Engineering, covering Deep learning and Technical documentation. It works with PyTorch and Python. The repository describes itself as: Tensors and Dynamic neural networks in Python with strong GPU acceleration.

When your agent uses it

  • A user asks to remove functions from conf.py ignore lists
  • Tasks that involve Deep learning
  • Tasks that involve Technical documentation

Example prompts

  • “/document-public-apis”

Requirements

  • Python 3

Workflow steps

8 steps, taken from the step headings in SKILL.md.

  1. Select module groups to document
  2. Present the batch to the user
  3. Comment out entries in conf.py
  4. Run Sphinx coverage
  5. Add documentation directives
  6. Verify with coverage
  7. Report progress
  8. Clean up commented-out entries in conf.py

What it can do on your machine

Read from SKILL.md and the folder at commit aa0dab7. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • make
    • python
    • pip

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use pip, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Document Public APIs loads about 4.2k tokens when it runs. Until then it costs about 87 tokens; SKILL.md has 1,814 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~87
When it runs · the whole SKILL.md, loaded when a task matches
~4.2k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 1,814 words (~4,159 tokens).

“This skill documents undocumented public APIs in PyTorch by removing entries from the coverage ignore lists in docs/source/conf.py and adding Sphinx autodoc directives (e.g., autosummary, currentmodule, autoclass, automodule) to the corresponding .md or .rst doc source files in docs/source/.”

— opening of SKILL.md by pytorch, Custom licence
name
document-public-apis

Read the full SKILL.md on GitHub

Files

Just SKILL.md in .agents/skills/document-public-apis of pytorch/pytorch.

Open the folder on GitHubat commit aa0dab7

Compare with similar skills

Document Public APIs next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Document Public APIs compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Document Public APIs this skillpytorch/pytorch104k—~4.2kAutomated safety check: PassCustom licence
Benchmark Pyreflyfacebook/pyrefly7.1k—~1.8kAutomated safety check: PassMIT
ExecuTorch Cortex-M Backendpytorch/executorch5.1k—~872Automated safety check: PassCustom licence
PyTorch Lightning TrainingOrchestra-Research/AI-Research-SKILLs13k7 repos~2.3kAutomated safety check: PassMIT
Ako4allTongmingLAIC/AKO4ALL369—~4kAutomated safety check: PassMIT
Homepage Generatorwanshuiyin/ARIS-in-AI-Offer580—~4.8kAutomated safety check: NotesMIT

Similar skills

  • Benchmark Pyrefly

    facebook/pyrefly

    Official

    Run Pyrefly benchmarks locally via Buck or Cargo, including PyTorch real-world LSP benchmarks.

    7.1k GitHub stars~1.8k tokensUpdated today
    AI & LLM EngineeringAuto-check passed
  • ExecuTorch Cortex-M Backend

    pytorch/executorch

    Developer guide for the Cortex-M (CMSIS-NN) backend in ExecuTorch: quantization pipeline, pass manager, tests and adding new ops.

    5.1k GitHub stars~872 tokensUpdated today
    AI & LLM EngineeringAuto-check passed
  • PyTorch Lightning Training

    Orchestra-Research/AI-Research-SKILLs

    Shows how to organize PyTorch training with Lightning's LightningModule and Trainer, covering validation, DDP, callbacks and learning-rate scheduling.

    13k GitHub starsUsed in 7 repos~2.3k tokens
    AI & LLM EngineeringAuto-check passed
  • Ako4all

    TongmingLAIC/AKO4ALL

    Drive an agentic loop that iteratively optimizes a GPU kernel for maximum speedup.

    369 GitHub stars~4k tokensUpdated 23 days ago
    AI & LLM EngineeringAuto-check passed
  • Homepage Generator

    wanshuiyin/ARIS-in-AI-Offer

    Generate a fact-checked academic personal homepage from a CV, optionally augmented by an existing manual homepage and an assets directory.

    580 GitHub stars~4.8k tokensUpdated 2 days ago
    AI & LLM EngineeringAuto-check: notes
  • Paddle Op Dev

    PaddlePaddle/Paddle

    PaddlePaddle (飞桨) C++ 算子开发指南。提供从 YAML 配置、InferMeta 函数、Kernel 实现、Python API 封装、单元测试到编译验证的完整算子开发流程指导。在以下场景使用此 skill:(1) 为 Paddle 框架新增 C++ 算子 (2) 修改或调试已有 Paddle 算子 (3) 编写算子的 YAML…

    24k GitHub stars~1.3k tokensUpdated 8 days ago
    AI & LLM EngineeringAuto-check passed

More from pytorch/pytorch

All 16 skills in this repo
  • Add Uint Support

    pytorch/pytorch

    Add unsigned integer (uint) type support to PyTorch operators by updating ATDISPATCH macros.

    104k GitHub starsUsed in 2 repos~2.3k tokens
    Auto-check passed
  • Docstring

    pytorch/pytorch

    Write docstrings for PyTorch functions and methods following PyTorch conventions.

    104k GitHub starsUsed in 2 repos~2.6k tokens
    Auto-check passed
  • Aoti Debug

    pytorch/pytorch

    Debug AOTInductor (AOTI) errors and crashes. An agent skill from pytorch/pytorch.

    104k GitHub starsUsed in 1 repo~1.7k tokens
    Auto-check passed
  • CI Metrics

    pytorch/pytorch

    Query PyTorch CI, GitHub Actions, HUD, Grafana, and infrastructure metrics.

    104k GitHub stars~1.1k tokensUpdated today
    Auto-check passed
  • Cuda Index Width

    pytorch/pytorch

    Choose 32-bit vs 64-bit index math in PyTorch CUDA kernels. An agent skill from pytorch/pytorch.

    104k GitHub stars~1.6k tokensUpdated today
    Auto-check passed
  • Fix Issue

    pytorch/pytorch

    Fix bugs reported in PyTorch GitHub issues by reproducing, root-causing, and implementing a fix in the local working tree.

    104k GitHub stars~2.3k tokensUpdated today
    Auto-check passed

Works with

Questions about Document Public APIs

What does Document Public APIs do?

Document undocumented public APIs in PyTorch by removing functions from coverageignorefunctions and coverageignoreclasses in docs/source/conf.py, running Sphinx coverage, and adding the appropriate…. Document Public APIs is an agent skill from pytorch/pytorch.rst doc files.

When should I use Document Public APIs?

Document Public APIs fits situations like: A user asks to remove functions from conf.py ignore lists; tasks that involve Deep learning; tasks that involve Technical documentation.

How do I install Document Public APIs in Claude Code?

Run `npx skills add pytorch/pytorch --skill document-public-apis -a claude-code`. Or copy the skill folder (.agents/skills/document-public-apis in pytorch/pytorch) into .claude/skills/document-public-apis in your project. Claude Code loads it when a task matches its description.

How do I install Document Public APIs in Codex?

Run `npx skills add pytorch/pytorch --skill document-public-apis -a codex`. Or copy the skill folder (.agents/skills/document-public-apis in pytorch/pytorch) into .agents/skills/document-public-apis in your project. Codex loads it when a task matches its description.

Can I use Document Public APIs in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add pytorch/pytorch --skill document-public-apis -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/document-public-apis, .gemini/skills/document-public-apis, .github/skills/document-public-apis and .opencode/skills/document-public-apis in your project.

What does Document Public APIs need to run?

Going by SKILL.md and its folder, Document Public APIs needs the command-line tools its instructions call (make, python and pip). Our summary lists: Python 3.

Does Document Public APIs access the network?

SKILL.md contains no URLs. Its commands use pip, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Document Public APIs safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Document Public APIs use?

Document Public APIs has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.

How many tokens does Document Public APIs use?

About 4.2k tokens (SKILL.md is roughly 17k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Document Public APIs?

Skills that share tags, products or a category with Document Public APIs: Benchmark Pyrefly (facebook/pyrefly, 7.1k stars), ExecuTorch Cortex-M Backend (pytorch/executorch, 5.1k stars), PyTorch Lightning Training (Orchestra-Research/AI-Research-SKILLs, 13k stars) and Ako4all (TongmingLAIC/AKO4ALL, 369 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Document Public APIs?

pytorch (a GitHub organization) maintains it in pytorch/pytorch, which has 103,867 GitHub stars. The repository holds 16 skills in this directory. The repository was last updated on October 8, 2026.

Source: pytorch/pytorch on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.