Skip to content

Docs: new model integration guide#9301

Open
Pfannkuchensack wants to merge 8 commits into
invoke-ai:mainfrom
Pfannkuchensack:docs/new-model-integration-guide
Open

Docs: new model integration guide#9301
Pfannkuchensack wants to merge 8 commits into
invoke-ai:mainfrom
Pfannkuchensack:docs/new-model-integration-guide

Conversation

@Pfannkuchensack

Copy link
Copy Markdown
Collaborator

Summary

A short guide on how to integrate new models into InvokeAi.

Checklist

  • The PR has a short but descriptive title, suitable for a changelog
  • Tests added / updated (if applicable)
  • ❗Changes to a redux slice have a corresponding migration
  • Documentation added / updated (if applicable)
  • Updated What's New copy (if doing a release after this PR)

Pfannkuchensack and others added 4 commits January 22, 2026 01:50
Comprehensive documentation covering all steps required to integrate
a new model type into InvokeAI, including:

- Backend: Model manager, configs, loaders, invocations, sampling
- Frontend: Graph building, state management, parameter recall
- Metadata, starter models, and optional features (ControlNet, LoRA, IP-Adapter)

Uses FLUX.1, FLUX.2 Klein, SD3, SDXL, and Z-Image as reference implementations.
- Move document to docs/contributing/ directory
- Fix broken TOC links by replacing '&' with 'and' in headings
- Add code example for text encoder config (section 2.4)
- Add text encoder loader example (new section 3.3)
- Expand text encoder invocation to show full conditioning flow (section 4.2)
@github-actions github-actions Bot added the docs PRs that change docs label Jun 24, 2026

@lstein lstein left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the old docs path. The new astro docs path is docs/src/content/docs/contributing. You should also ensure that the style matches the current documentation.

Note that I've tagged this for 6.14, but it could go in earlier if ready.

@lstein lstein self-assigned this Jun 26, 2026
@lstein lstein added the 6.14.x label Jun 26, 2026
@lstein lstein moved this to 6.14.x Theme: USER EXPERIENCE in Invoke - Community Roadmap Jun 26, 2026
Move the New Model Type Integration guide from the legacy docs/contributing
path into the astro docs tree and restyle it to match current documentation
conventions (frontmatter, <Steps>, code block titles, :::tip checklists,
<FileTree>).
@Pfannkuchensack

Copy link
Copy Markdown
Collaborator Author
localhost_4321_development_guides_models_ Should be right now.

@Pfannkuchensack Pfannkuchensack requested a review from lstein July 2, 2026 05:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

6.14.x docs PRs that change docs

Projects

Status: 6.14.x Theme: USER EXPERIENCE

Development

Successfully merging this pull request may close these issues.

2 participants