2023-10-05 05:29:16 +00:00
|
|
|
from typing import Union
|
|
|
|
|
|
2024-01-02 00:13:49 +00:00
|
|
|
from pydantic import BaseModel, ConfigDict, Field, field_validator, model_validator
|
2023-10-05 05:29:16 +00:00
|
|
|
|
|
|
|
|
from invokeai.app.invocations.baseinvocation import (
|
|
|
|
|
BaseInvocation,
|
|
|
|
|
BaseInvocationOutput,
|
|
|
|
|
InvocationContext,
|
|
|
|
|
invocation,
|
|
|
|
|
invocation_output,
|
|
|
|
|
)
|
|
|
|
|
from invokeai.app.invocations.controlnet_image_processors import CONTROLNET_RESIZE_VALUES
|
2024-01-13 04:23:06 +00:00
|
|
|
from invokeai.app.invocations.fields import FieldDescriptions, Input, InputField, OutputField
|
2023-10-05 05:29:16 +00:00
|
|
|
from invokeai.app.invocations.primitives import ImageField
|
2024-01-02 00:13:49 +00:00
|
|
|
from invokeai.app.invocations.util import validate_begin_end_step, validate_weights
|
2023-10-05 05:29:16 +00:00
|
|
|
from invokeai.backend.model_management.models.base import BaseModelType
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class T2IAdapterModelField(BaseModel):
|
|
|
|
|
model_name: str = Field(description="Name of the T2I-Adapter model")
|
|
|
|
|
base_model: BaseModelType = Field(description="Base model")
|
|
|
|
|
|
feat(api): chore: pydantic & fastapi upgrade
Upgrade pydantic and fastapi to latest.
- pydantic~=2.4.2
- fastapi~=103.2
- fastapi-events~=0.9.1
**Big Changes**
There are a number of logic changes needed to support pydantic v2. Most changes are very simple, like using the new methods to serialized and deserialize models, but there are a few more complex changes.
**Invocations**
The biggest change relates to invocation creation, instantiation and validation.
Because pydantic v2 moves all validation logic into the rust pydantic-core, we may no longer directly stick our fingers into the validation pie.
Previously, we (ab)used models and fields to allow invocation fields to be optional at instantiation, but required when `invoke()` is called. We directly manipulated the fields and invocation models when calling `invoke()`.
With pydantic v2, this is much more involved. Changes to the python wrapper do not propagate down to the rust validation logic - you have to rebuild the model. This causes problem with concurrent access to the invocation classes and is not a free operation.
This logic has been totally refactored and we do not need to change the model any more. The details are in `baseinvocation.py`, in the `InputField` function and `BaseInvocation.invoke_internal()` method.
In the end, this implementation is cleaner.
**Invocation Fields**
In pydantic v2, you can no longer directly add or remove fields from a model.
Previously, we did this to add the `type` field to invocations.
**Invocation Decorators**
With pydantic v2, we instead use the imperative `create_model()` API to create a new model with the additional field. This is done in `baseinvocation.py` in the `invocation()` wrapper.
A similar technique is used for `invocation_output()`.
**Minor Changes**
There are a number of minor changes around the pydantic v2 models API.
**Protected `model_` Namespace**
All models' pydantic-provided methods and attributes are prefixed with `model_` and this is considered a protected namespace. This causes some conflict, because "model" means something to us, and we have a ton of pydantic models with attributes starting with "model_".
Forunately, there are no direct conflicts. However, in any pydantic model where we define an attribute or method that starts with "model_", we must tell set the protected namespaces to an empty tuple.
```py
class IPAdapterModelField(BaseModel):
model_name: str = Field(description="Name of the IP-Adapter model")
base_model: BaseModelType = Field(description="Base model")
model_config = ConfigDict(protected_namespaces=())
```
**Model Serialization**
Pydantic models no longer have `Model.dict()` or `Model.json()`.
Instead, we use `Model.model_dump()` or `Model.model_dump_json()`.
**Model Deserialization**
Pydantic models no longer have `Model.parse_obj()` or `Model.parse_raw()`, and there are no `parse_raw_as()` or `parse_obj_as()` functions.
Instead, you need to create a `TypeAdapter` object to parse python objects or JSON into a model.
```py
adapter_graph = TypeAdapter(Graph)
deserialized_graph_from_json = adapter_graph.validate_json(graph_json)
deserialized_graph_from_dict = adapter_graph.validate_python(graph_dict)
```
**Field Customisation**
Pydantic `Field`s no longer accept arbitrary args.
Now, you must put all additional arbitrary args in a `json_schema_extra` arg on the field.
**Schema Customisation**
FastAPI and pydantic schema generation now follows the OpenAPI version 3.1 spec.
This necessitates two changes:
- Our schema customization logic has been revised
- Schema parsing to build node templates has been revised
The specific aren't important, but this does present additional surface area for bugs.
**Performance Improvements**
Pydantic v2 is a full rewrite with a rust backend. This offers a substantial performance improvement (pydantic claims 5x to 50x depending on the task). We'll notice this the most during serialization and deserialization of sessions/graphs, which happens very very often - a couple times per node.
I haven't done any benchmarks, but anecdotally, graph execution is much faster. Also, very larges graphs - like with massive iterators - are much, much faster.
2023-09-24 08:11:07 +00:00
|
|
|
model_config = ConfigDict(protected_namespaces=())
|
|
|
|
|
|
2023-10-05 05:29:16 +00:00
|
|
|
|
|
|
|
|
class T2IAdapterField(BaseModel):
|
|
|
|
|
image: ImageField = Field(description="The T2I-Adapter image prompt.")
|
|
|
|
|
t2i_adapter_model: T2IAdapterModelField = Field(description="The T2I-Adapter model to use.")
|
|
|
|
|
weight: Union[float, list[float]] = Field(default=1, description="The weight given to the T2I-Adapter")
|
|
|
|
|
begin_step_percent: float = Field(
|
|
|
|
|
default=0, ge=0, le=1, description="When the T2I-Adapter is first applied (% of total steps)"
|
|
|
|
|
)
|
|
|
|
|
end_step_percent: float = Field(
|
|
|
|
|
default=1, ge=0, le=1, description="When the T2I-Adapter is last applied (% of total steps)"
|
|
|
|
|
)
|
|
|
|
|
resize_mode: CONTROLNET_RESIZE_VALUES = Field(default="just_resize", description="The resize mode to use")
|
|
|
|
|
|
2024-01-02 00:13:49 +00:00
|
|
|
@field_validator("weight")
|
|
|
|
|
@classmethod
|
|
|
|
|
def validate_ip_adapter_weight(cls, v):
|
|
|
|
|
validate_weights(v)
|
|
|
|
|
return v
|
|
|
|
|
|
|
|
|
|
@model_validator(mode="after")
|
|
|
|
|
def validate_begin_end_step_percent(self):
|
|
|
|
|
validate_begin_end_step(self.begin_step_percent, self.end_step_percent)
|
|
|
|
|
return self
|
|
|
|
|
|
2023-10-05 05:29:16 +00:00
|
|
|
|
|
|
|
|
@invocation_output("t2i_adapter_output")
|
|
|
|
|
class T2IAdapterOutput(BaseInvocationOutput):
|
|
|
|
|
t2i_adapter: T2IAdapterField = OutputField(description=FieldDescriptions.t2i_adapter, title="T2I Adapter")
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@invocation(
|
2024-01-02 00:13:49 +00:00
|
|
|
"t2i_adapter", title="T2I-Adapter", tags=["t2i_adapter", "control"], category="t2i_adapter", version="1.0.1"
|
2023-10-05 05:29:16 +00:00
|
|
|
)
|
|
|
|
|
class T2IAdapterInvocation(BaseInvocation):
|
|
|
|
|
"""Collects T2I-Adapter info to pass to other nodes."""
|
|
|
|
|
|
|
|
|
|
# Inputs
|
|
|
|
|
image: ImageField = InputField(description="The IP-Adapter image prompt.")
|
2023-10-06 09:16:00 +00:00
|
|
|
t2i_adapter_model: T2IAdapterModelField = InputField(
|
2023-10-05 05:29:16 +00:00
|
|
|
description="The T2I-Adapter model.",
|
|
|
|
|
title="T2I-Adapter Model",
|
|
|
|
|
input=Input.Direct,
|
|
|
|
|
ui_order=-1,
|
|
|
|
|
)
|
|
|
|
|
weight: Union[float, list[float]] = InputField(
|
feat(ui): add support for custom field types
Node authors may now create their own arbitrary/custom field types. Any pydantic model is supported.
Two notes:
1. Your field type's class name must be unique.
Suggest prefixing fields with something related to the node pack as a kind of namespace.
2. Custom field types function as connection-only fields.
For example, if your custom field has string attributes, you will not get a text input for that attribute when you give a node a field with your custom type.
This is the same behaviour as other complex fields that don't have custom UIs in the workflow editor - like, say, a string collection.
feat(ui): fix tooltips for custom types
We need to hold onto the original type of the field so they don't all just show up as "Unknown".
fix(ui): fix ts error with custom fields
feat(ui): custom field types connection validation
In the initial commit, a custom field's original type was added to the *field templates* only as `originalType`. Custom fields' `type` property was `"Custom"`*. This allowed for type safety throughout the UI logic.
*Actually, it was `"Unknown"`, but I changed it to custom for clarity.
Connection validation logic, however, uses the *field instance* of the node/field. Like the templates, *field instances* with custom types have their `type` set to `"Custom"`, but they didn't have an `originalType` property. As a result, all custom fields could be connected to all other custom fields.
To resolve this, we need to add `originalType` to the *field instances*, then switch the validation logic to use this instead of `type`.
This ended up needing a bit of fanagling:
- If we make `originalType` a required property on field instances, existing workflows will break during connection validation, because they won't have this property. We'd need a new layer of logic to migrate the workflows, adding the new `originalType` property.
While this layer is probably needed anyways, typing `originalType` as optional is much simpler. Workflow migration logic can come layer.
(Technically, we could remove all references to field types from the workflow files, and let the templates hold all this information. This feels like a significant change and I'm reluctant to do it now.)
- Because `originalType` is optional, anywhere we care about the type of a field, we need to use it over `type`. So there are a number of `field.originalType ?? field.type` expressions. This is a bit of a gotcha, we'll need to remember this in the future.
- We use `Array.prototype.includes()` often in the workflow editor, e.g. `COLLECTION_TYPES.includes(type)`. In these cases, the const array is of type `FieldType[]`, and `type` is is `FieldType`.
Because we now support custom types, the arg `type` is now widened from `FieldType` to `string`.
This causes a TS error. This behaviour is somewhat controversial (see https://github.com/microsoft/TypeScript/issues/14520). These expressions are now rewritten as `COLLECTION_TYPES.some((t) => t === type)` to satisfy TS. It's logically equivalent.
fix(ui): typo
feat(ui): add CustomCollection and CustomPolymorphic field types
feat(ui): add validation for CustomCollection & CustomPolymorphic types
- Update connection validation for custom types
- Use simple string parsing to determine if a field is a collection or polymorphic type.
- No longer need to keep a list of collection and polymorphic types.
- Added runtime checks in `baseinvocation.py` to ensure no fields are named in such a way that it could mess up the new parsing
chore(ui): remove errant console.log
fix(ui): rename 'nodes.currentConnectionFieldType' -> 'nodes.connectionStartFieldType'
This was confusingly named and kept tripping me up. Renamed to be consistent with the `reactflow` `ConnectionStartParams` type.
fix(ui): fix ts error
feat(nodes): add runtime check for custom field names
"Custom", "CustomCollection" and "CustomPolymorphic" are reserved field names.
chore(ui): add TODO for revising field type names
wip refactor fieldtype structured
wip refactor field types
wip refactor types
wip refactor types
fix node layout
refactor field types
chore: mypy
organisation
organisation
organisation
fix(nodes): fix field orig_required, field_kind and input statuses
feat(nodes): remove broken implementation of default_factory on InputField
Use of this could break connection validation due to the difference in node schemas required fields and invoke() required args.
Removed entirely for now. It wasn't ever actually used by the system, because all graphs always had values provided for fields where default_factory was used.
Also, pydantic is smart enough to not reuse the same object when specifying a default value - it clones the object first. So, the common pattern of `default_factory=list` is extraneous. It can just be `default=[]`.
fix(nodes): fix InputField name validation
workflow validation
validation
chore: ruff
feat(nodes): fix up baseinvocation comments
fix(ui): improve typing & logic of buildFieldInputTemplate
improved error handling in parseFieldType
fix: back compat for deprecated default_factory and UIType
feat(nodes): do not show node packs loaded log if none loaded
chore(ui): typegen
2023-11-17 00:32:35 +00:00
|
|
|
default=1, ge=0, description="The weight given to the T2I-Adapter", title="Weight"
|
2023-10-05 05:29:16 +00:00
|
|
|
)
|
|
|
|
|
begin_step_percent: float = InputField(
|
2024-01-02 00:13:49 +00:00
|
|
|
default=0, ge=0, le=1, description="When the T2I-Adapter is first applied (% of total steps)"
|
2023-10-05 05:29:16 +00:00
|
|
|
)
|
|
|
|
|
end_step_percent: float = InputField(
|
|
|
|
|
default=1, ge=0, le=1, description="When the T2I-Adapter is last applied (% of total steps)"
|
|
|
|
|
)
|
|
|
|
|
resize_mode: CONTROLNET_RESIZE_VALUES = InputField(
|
|
|
|
|
default="just_resize",
|
|
|
|
|
description="The resize mode applied to the T2I-Adapter input image so that it matches the target output size.",
|
|
|
|
|
)
|
|
|
|
|
|
2024-01-02 00:13:49 +00:00
|
|
|
@field_validator("weight")
|
|
|
|
|
@classmethod
|
|
|
|
|
def validate_ip_adapter_weight(cls, v):
|
|
|
|
|
validate_weights(v)
|
|
|
|
|
return v
|
|
|
|
|
|
|
|
|
|
@model_validator(mode="after")
|
|
|
|
|
def validate_begin_end_step_percent(self):
|
|
|
|
|
validate_begin_end_step(self.begin_step_percent, self.end_step_percent)
|
|
|
|
|
return self
|
|
|
|
|
|
2023-10-05 05:29:16 +00:00
|
|
|
def invoke(self, context: InvocationContext) -> T2IAdapterOutput:
|
|
|
|
|
return T2IAdapterOutput(
|
|
|
|
|
t2i_adapter=T2IAdapterField(
|
|
|
|
|
image=self.image,
|
2023-10-06 09:16:00 +00:00
|
|
|
t2i_adapter_model=self.t2i_adapter_model,
|
2023-10-05 05:29:16 +00:00
|
|
|
weight=self.weight,
|
|
|
|
|
begin_step_percent=self.begin_step_percent,
|
|
|
|
|
end_step_percent=self.end_step_percent,
|
|
|
|
|
resize_mode=self.resize_mode,
|
|
|
|
|
)
|
|
|
|
|
)
|
