Document `cog debug` command
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Go
- Stars
- 9.5k
- Forks
- 696
- Avg merge
- 7d 19h
- Merged PRs (30d)
- 2
Description
Cog has a debug command that outputs the Dockerfile for the current cog model, but it's not documented.
cog debug > Dockerfile
It's not available in help:
$ cog --help
Containers for machine learning.
...
Available Commands:
build Build an image from cog.yaml
completion Generate the autocompletion script for the specified shell
help Help about any command
init Configure your project for use with Cog
login Log in to Replicate Docker registry
predict Run a prediction
push Build and push model in current directory to a Docker registry
run Run a command inside a Docker environment
This command is mentioned in passing in the getting started guide, but is not present in any reference documentation.
See also:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/getting-started.md and the existing cog --help output to understand how commands are documented. Add reference documentation for cog debug, including that it outputs the Dockerfile for the current Cog model and the shown redirection example; done means the command is no longer documented only in passing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100