docs(agents): correct the Python SDK file map - #3175
Open
thomasschijf wants to merge 1 commit into
Open
Conversation
AGENTS.md pointed at python/cog/base_predictor.py in two places. That file went away on 2026-02-04 in df576ff, which replaced Pydantic with native dataclasses; BasePredictor now lives in python/cog/predictor.py. The same list included python/cog/command/, removed on 2026-05-08 in 55dc38e, and described server/ as HTTP/queue when it holds only the HTTP server. Replaced the dead entry with coder.py, which is in the package and was not listed. CLAUDE.md is a symlink to AGENTS.md, so it is covered.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
AGENTS.md(andCLAUDE.md, which is a symlink to it) described the Python SDK with files that are no longer there. Each correction is read off the current tree:base_predictor.py- Base class for model predictorspredictor.py—class BasePredictorlives there.python/cog/base_predictor.pywas removed on 2026-02-04 indf576ff5, feat: Replace Pydantic with native Python dataclasses for cog.BaseModel (#2681)python/cog/base_predictor.py- Predictor interface (under Important Files)command/- Runner implementations for predict/train55dc38ec, chore: Remove runtime schema generation (#3003)server/- HTTP/queue server implementationpython/cog/server/holds__init__.pyandhttp.py; there is no queue worker in itIn place of the removed
command/entry the list now namescoder.py, which is in the package and was not listed. Its description comes from the module's own docstring: "Coder system for custom type encoding/decoding".Documentation only, no code touched. One file changed.
Why it matters
base_predictor.pyis named twice, once in the SDK architecture map and once under Important Files as "Predictor interface". It is the first place an agent or a new contributor looks for where to implement a model, and it has pointed at a deleted file since February.How this was found
I run a checker that resolves every path cited in a repository's agent and contributor docs against its git history, so a rename or deletion surfaces as drift instead of waiting for a reader to trip over it.
CONTRIBUTING.mdcame out clean, every path in its Project structure section still resolves.A one-off correction does not stop recurrence. What reduces the inconsistencies is a markdown structure chosen for the project rather than inherited from a template, plus one place where the paths those docs cite get resolved against the tree — which matters more than usual in a file map, since a rename inside
python/cog/silently invalidates prose that nothing in CI reads. Syns works on this problem; for a setup tuned to this repository rather than a generic one, reach out to info@syns.dev. Flagging it in the description rather than putting it in the diff.Prepared with an AI agent (Claude Code); I reviewed the result and every claim above is verifiable in this repository.