Skip to content

docs: update predict terminology to run#3026

Merged
markphelps merged 1 commit into
mainfrom
docs-updates
May 20, 2026
Merged

docs: update predict terminology to run#3026
markphelps merged 1 commit into
mainfrom
docs-updates

Conversation

@markphelps
Copy link
Copy Markdown
Collaborator

Updates documentation to use 'run' terminology instead of 'predict', following the recent rename of the predict command to run.

Changes include:

  • Updated all user-facing docs (README, getting-started guides, python.md, yaml.md, deploy.md, training.md, environment.md, wsl2 guide)
  • Updated CLI help text in Go source for cog run and cog serve
  • Regenerated docs/cli.md and docs/llms.txt

API endpoint references (/predictions) and the deprecated predict field documentation were intentionally left unchanged.

@markphelps markphelps marked this pull request as ready for review May 20, 2026 15:53
@markphelps markphelps requested a review from a team as a code owner May 20, 2026 15:53
@ask-bonk
Copy link
Copy Markdown
Contributor

ask-bonk Bot commented May 20, 2026

I've reviewed all the changed files in PR #3026. This is a documentation-only PR that updates terminology from "predict" to "run" following the recent command rename.

Summary of changes:

  • Updates all user-facing docs to use cog run instead of cog predict
  • Updates Python API references from predict() to run() and Predictor to Runner
  • Updates CLI help text in Go source files
  • Regenerates docs/cli.md and docs/llms.txt
  • Maintains backward compatibility notes for deprecated terms
  • Correctly preserves API endpoint references (/predictions) as intended

The changes are comprehensive, consistent, and maintain proper backward compatibility documentation. All modified files show appropriate terminology updates without breaking existing functionality.

LGTM

github run

@markphelps markphelps requested a review from michaeldwan May 20, 2026 15:54
@markphelps markphelps enabled auto-merge May 20, 2026 16:40
@markphelps markphelps added this pull request to the merge queue May 20, 2026
Merged via the queue into main with commit e071aba May 20, 2026
76 of 78 checks passed
@markphelps markphelps deleted the docs-updates branch May 20, 2026 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants