ArtVentureX / sd-webui-agent-scheduler

627 stars 65 forks source link

What does comments do in text2image agent scheduler API ? #172

Open dm18 opened 10 months ago

dm18 commented 10 months ago

I've tried passing text using comments in the API, but it doesn't seem to show up any where. Like not in agent scheduler tab, and or the meta data of the image. And it doesn't seem to triggered any kind of error message.

What does comments do? Is there a special format the data is expected to follow?

I've tired like

"comments": {"valueName": value},

"comments": {"string"},

It seems like it could be useful.

artventuredev commented 10 months ago

The agent scheduler's APIs are inherited from the original webui APIs, including the comments arg. I'm not 100% sure the purpose of this arg, but you can safely ignore it.

dm18 commented 10 months ago

I was curios, so I looked through the code base for automatic1111. I think it's the comment is displayed under the preview image in the webui. The typical usage seems to be comment = comment + html text. Not as useful as hoped. But mystery solved.