-
Notifications
You must be signed in to change notification settings - Fork 57
docs: add image generation documentation and image-to-image editing tutorial #319
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: nmulepati/feat/125-support-image-generation
Are you sure you want to change the base?
docs: add image generation documentation and image-to-image editing tutorial #319
Conversation
Greptile OverviewGreptile SummaryThis PR adds comprehensive documentation for the image generation feature, including a new Tutorial 6 that demonstrates image-to-image editing using seed datasets and
The documentation is clear, well-structured, and consistent with existing tutorials. All Colab notebooks were properly regenerated from source files. The previously reported model classification issue has been addressed in a prior commit.
|
| Filename | Overview |
|---|---|
| docs/concepts/columns.md | Added Image Columns section documenting diffusion/autoregressive models, Jinja2 prompts, output modes, and multi_modal_context; updated count from ten to eleven column types |
| docs/concepts/models/inference-parameters.md | Added comprehensive Image Inference Parameters section with fields table, examples for autoregressive and diffusion models; updated intro to mention all three parameter types |
| docs/notebook_source/6-editing-images-with-image-context.py | New tutorial demonstrating image-to-image editing with AFHQ dataset, multi_modal_context for autoregressive models, and before/after comparisons |
| docs/notebook_source/5-generating-images.py | Fixed image display code using IPImage filename parameter, added link to Tutorial 6, minor typo fix |
| mkdocs.yml | Added Tutorial 5 and Tutorial 6 to navigation structure |
| docs/colab_notebooks/6-editing-images-with-image-context.ipynb | Generated Colab notebook from Tutorial 6 source with installation and API key setup cells |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
13 files reviewed, 2 comments
Additional Comments (1)
This tutorial states “Set Prompt To Fix With AIThis is a comment left during a code review.
Path: docs/colab_notebooks/6-editing-images-with-image-context.ipynb
Line: 1464:1472
Comment:
**Missing API-key setup**
This tutorial states “Set `OPENROUTER_API_KEY` in your environment”, but the notebook’s setup cell only populates `NVIDIA_API_KEY`. As written, a fresh Colab run will fail/authenticate incorrectly for the chosen provider unless the user manually sets `OPENROUTER_API_KEY` outside the notebook.
How can I resolve this? If you propose a fix, please make it concise. |
Relabel flux.2-pro/openrouter example from "Diffusion model" to "Autoregressive model" to match its usage elsewhere in the docs. Regenerate colab notebooks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
17 files reviewed, 1 comment
Additional Comments (1)
Fix by including both Also appears in: Prompt To Fix With AIThis is a comment left during a code review.
Path: packages/data-designer-config/src/data_designer/config/utils/image_helpers.py
Line: 20:22
Comment:
**Broken `.jpeg` detection**
`SUPPORTED_IMAGE_EXTENSIONS` lowercases the enum values (`fmt.value.lower()`), but `ImageFormat.JPEG.value` is already `"jpg"` (see `detect_image_format()` mapping) while `is_image_path()`/`is_image_url()` tests expect `.jpeg` to be supported. With the current list, `.jpeg` files/URLs will no longer be recognized.
Fix by including both `.jpg` and `.jpeg` (or avoid lowercasing/altering enum values and keep `get_supported_image_extensions()` behavior). Also update the list type to a tuple or set if immutability/perf matters.
Also appears in: `is_image_url()` usage of `SUPPORTED_IMAGE_EXTENSIONS` in the same file.
How can I resolve this? If you propose a fix, please make it concise. |
…pati/docs/image-generation
📋 Summary
Add comprehensive documentation for the image generation feature and a new tutorial demonstrating image-to-image editing with seed datasets.
🔄 Changes
✨ Added
ImageColumnConfigwithmulti_modal_contextto generate accessorized versions (sunglasses, top hats, bow ties, etc.)docs/concepts/columns.md— Documents the 🖼️ Image Columns type (diffusion vs autoregressive, Jinja2 prompts, preview vs create output modes, multi_modal_context)docs/concepts/models/inference-parameters.md— DocumentsImageInferenceParamsfields, examples for diffusion and DALL·E-style models, API auto-selection🔧 Changed
mkdocs.yml— Added Tutorial 5 (Generating Images) and Tutorial 6 (Image-to-Image Editing) to the site navigationdocs/code_reference/models.md— Updated intro to mentionImageInferenceParams, added link to Tutorial 6docs/notebook_source/5-generating-images.py— Added link to Tutorial 6 in next steps sectiondocs/concepts/columns.md— Updated column count from "ten" to "eleven"docs/concepts/models/inference-parameters.md— Updated intro to mention all three inference parameter types#317 should merge first