invoke-ai
[Docs] ELI5 Tutorial For Invocations
Work in progress. Just putting it out there to see if its worth pursuing writing indepth detailed guides.
Can be previewed here: https://github.com/blessedcoolant/InvokeAI/blob/docs-invocations/docs/contributing/INVOCATIONS.md
This type of documentation is going to be critical. Thanks for putting it together. I've given it a once over, but will get perspective of @brandonrising next week on how clear it is to fresh eyes, and where we can expand.
This looks great! Definitely valuable and worth investing in. One question for the advanced section probably, are invocations allowed to use InvokeAIAppConfig? Any best practices there?
FWIW - I'm planning on writing a blog post or two about converting some arbitrary paper's sample code into an invocation. Probably SAM (or a variant) and Deep Floyd. Started to do that already but figured I should wait until the new model management stuff is in.
self.is_intermediateis used but never defined
Yes. I'll update this when I'm refining the PR later. I'm just waiting on all the services to settle in. self.is_intermediate is used to determine an intermediate image. Not applicable in this case.
are invocations allowed to use InvokeAIAppConfig
Basically we'll want the dev to access the config via the service rather than trying to instantiate their own class of InvokeAIAppConfig .. so it should be context.services.configuration.xxxx to access any of the data provided by the app config. But services are only applicable inside the invoke context. If you want to use them outside of it, I think we load the global instance. I'll let @lstein chime in on that because he has a better knowledge of the workings of InvokeAIAppConfig
@blessedcoolant - Thoughts on the status/timing of this doc? Have it on the list of things to have ready for 3.0 launch
The docs are good for the backend stuff. They front end stuff is still WIP. But that's a big write up. So don't really have an ETA on that.
The docs are good for the backend stuff. They front end stuff is still WIP. But that's a big write up. So don't really have an ETA on that.
Ok - should we merge this in then? Or can merge over to the doc-updates branch if you want
The docs are good for the backend stuff. They front end stuff is still WIP. But that's a big write up. So don't really have an ETA on that.
Ok - should we merge this in then? Or can merge over to the doc-updates branch if you want
Yeah. Soak it into that. When I do more documentation for the front end stuff, I can build on that. But that'll have to wait for a bit.