mirror of
https://github.com/invoke-ai/InvokeAI
synced 2024-08-30 20:32:17 +00:00
46 lines
1.4 KiB
Markdown
46 lines
1.4 KiB
Markdown
|
# Invocation API
|
||
|
|
|
||
|
|
Each invocation's `invoke` method is provided a single arg - the Invocation
|
||
|
|
Context.
|
||
|
|
|
||
|
|
This object provides access to various methods, used to interact with the
|
||
|
|
application. Loading and saving images, logging messages, etc.
|
||
|
|
|
||
|
|
!!! warning ""
|
||
|
|
|
||
|
|
This API may shift slightly until the release of v4.0.0 as we work through a few final updates to the Model Manager.
|
||
|
|
|
||
|
|
```py
|
||
|
|
class MyInvocation(BaseInvocation):
|
||
|
|
...
|
||
|
|
def invoke(self, context: InvocationContext) -> ImageOutput:
|
||
|
|
image_pil = context.images.get_pil(image_name)
|
||
|
|
# Do something to the image
|
||
|
|
image_dto = context.images.save(image_pil)
|
||
|
|
# Log a message
|
||
|
|
context.logger.info(f"Did something cool, image saved!")
|
||
|
|
...
|
||
|
|
```
|
||
|
|
|
||
|
|
<!-- prettier-ignore-start -->
|
||
|
|
::: invokeai.app.services.shared.invocation_context.InvocationContext
|
||
|
|
options:
|
||
|
|
members: false
|
||
|
|
|
||
|
|
::: invokeai.app.services.shared.invocation_context.ImagesInterface
|
||
|
|
|
||
|
|
::: invokeai.app.services.shared.invocation_context.TensorsInterface
|
||
|
|
|
||
|
|
::: invokeai.app.services.shared.invocation_context.ConditioningInterface
|
||
|
|
|
||
|
|
::: invokeai.app.services.shared.invocation_context.ModelsInterface
|
||
|
|
|
||
|
|
::: invokeai.app.services.shared.invocation_context.LoggerInterface
|
||
|
|
|
||
|
|
::: invokeai.app.services.shared.invocation_context.ConfigInterface
|
||
|
|
|
||
|
|
::: invokeai.app.services.shared.invocation_context.UtilInterface
|
||
|
|
|
||
|
|
::: invokeai.app.services.shared.invocation_context.BoardsInterface
|
||
|
|
<!-- prettier-ignore-end -->
|