Skip to content

The most powerful and modular diffusion model GUI, api and backend with a graph/nodes interface. The fastest local inference engine in the world.

Document get_attr and get_model_object (#6357)

Chenlei Hud055325783ef
diff --git a/comfy/model_patcher.py b/comfy/model_patcher.py
index 4597ce11c..e886bdbb7 100644
--- a/comfy/model_patcher.py
+++ b/comfy/model_patcher.py
@@ -402,7 +402,20 @@ class ModelPatcher:
def add_object_patch(self, name, obj):
self.object_patches[name] = obj
- def get_model_object(self, name):
+ def get_model_object(self, name: str) -> torch.nn.Module:
+ """Retrieves a nested attribute from an object using dot notation considering
+ object patches.
+
+ Args:
+ name (str): The attribute path using dot notation (e.g. "model.layer.weight")
+
+ Returns:
+ The value of the requested attribute
+
+ Example:
+ patcher = ModelPatcher()
+ weight = patcher.get_model_object("layer1.conv.weight")
+ """
if name in self.object_patches:
return self.object_patches[name]
else:
diff --git a/comfy/utils.py b/comfy/utils.py
index ea666ae5b..b486b2deb 100644
--- a/comfy/utils.py
+++ b/comfy/utils.py
@@ -693,7 +693,25 @@ def copy_to_param(obj, attr, value):
prev = getattr(obj, attrs[-1])
prev.data.copy_(value)
-def get_attr(obj, attr):
+def get_attr(obj, attr: str):
+ """Retrieves a nested attribute from an object using dot notation.
+
+ Args:
+ obj: The object to get the attribute from
+ attr (str): The attribute path using dot notation (e.g. "model.layer.weight")
+
+ Returns:
+ The value of the requested attribute
+
+ Example:
+ model = MyModel()
+ weight = get_attr(model, "layer1.conv.weight")
+ # Equivalent to: model.layer1.conv.weight
+
+ Important:
+ Always prefer `comfy.model_patcher.ModelPatcher.get_model_object` when
+ accessing nested model objects under `ModelPatcher.model`.
+ """
attrs = attr.split(".")
for name in attrs:
obj = getattr(obj, name)