docs: document --use-cog-base-image and prebuilt base images#3088
docs: document --use-cog-base-image and prebuilt base images#3088anish-sahoo wants to merge 12 commits into
Conversation
There was a problem hiding this comment.
I'm Bonk, and I've done a quick review of your PR.
This PR adds clear documentation for Cog's prebuilt base images and how the --use-cog-base-image / --use-cuda-base-image flags interact. Overall the content is accurate and well-placed.
One issue found:
- docs/llms.txt is missing the new base-images.md content — The generation script (
mise run docs:llm) usesgit ls-filesto discover docs, so if it was run beforebase-images.mdwas tracked by git, the new page won't be included. The currentllms.txtonly shows the +7 lines from the getting-started guides, but is missing the ~70 lines of new base-images content. Please regenerate it after ensuringbase-images.mdis staged/committed.
|
Done — posted a review on PR #3088 noting that |
|
LGTM |
Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com> Signed-off-by: Anish Sahoo <anishsahoo2005@gmail.com>
Merge from #3089 introduced a duplicate TestConcurrentDecoratorIgnoredWhenNotFromCog function signature that caused a syntax error.
|
LGTM |
|
LGTM |
There was a problem hiding this comment.
I'm Bonk, and I've done a quick review of your PR.
This PR adds clear documentation for Cog's prebuilt base images and how the --use-cog-base-image / --use-cuda-base-image flags interact. The content is accurate and well-placed.
One issue found:
- Incorrect example base image tag format — The example tag
r8.im/cog-base:cuda12-python3.13-torch2.6doesn't match the actual format produced by Cog. TheBaseImageNamefunction usesversion.StripPatch()for CUDA and Python (preserving minor versions like12.4), and the full torch version from the compatibility matrix (e.g.,2.6.0). Actual tags look likecuda12.4-python3.13-torch2.6.0.
|
I'm Bonk, and I've done a quick review of your PR. This PR adds clear documentation for Cog's prebuilt base images and how the One issue found:
Posted review: #3088 (review) |
Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com> Signed-off-by: Anish Sahoo <anishsahoo2005@gmail.com>
There was a problem hiding this comment.
I'm Bonk, and I've done a quick review of your PR.
This PR adds clear documentation for Cog's prebuilt base images and how the --use-cog-base-image / --use-cuda-base-image flags interact. The content is accurate and well-placed.
One issue found:
- Stale content in
docs/llms.txt— Thellms.txtfile contains the old incorrect base image tag format (cuda12-python3.13-torch2.6) in thebase-images.mdsection, butdocs/base-images.mditself was already fixed to show the correct format (cuda12.4-python3.13-torch2.6.0). Please regeneratedocs/llms.txtso it picks up the latestbase-images.mdcontent.
|
I'm Bonk, and I've done a quick review of your PR. This PR adds clear documentation for Cog's prebuilt base images and how the One issue found:
Posted review: #3088 (review) |
|
LGTM |
|
LGTM |
Closes #1820
Summary
docs/base-images.mdpage explaining what Cog prebuilt base images are, what's on them, and how to use/disable--use-cog-base-image--use-cog-base-imageand--use-cuda-base-image(mutually exclusive; cuda flag only takes effect when cog base image is disabled)docs/getting-started.mdanddocs/getting-started-own-model.mdwith notes about default base-image behavior and links to the new pagedocs/llms.txtValidation
prettier --checkpasses on all changed filesmise run docs:llmsucceedsdocs/cli.mdunchanged (already in sync)