docs: document --use-cog-base-image and prebuilt base images#3088
Open
anish-sahoo wants to merge 8 commits into
Open
docs: document --use-cog-base-image and prebuilt base images#3088anish-sahoo wants to merge 8 commits into
anish-sahoo wants to merge 8 commits into
Conversation
![ask-bonk[bot]](https://avatars.githubusercontent.com/in/2454580?s=60&v=4){kind=small}
Contributor
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.
Contributor
|
Done — posted a review on PR #3088 noting that |
Contributor
|
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.
Contributor
|
LGTM |
Contributor
|
LGTM |
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.
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)