ComfyUI Node: Queue on remote (worker)

Queue on remote (worker):

The RemoteQueueWorker node is designed to facilitate the execution of jobs on a remote worker, enabling distributed processing and efficient task management. This node is particularly useful for AI artists who need to offload intensive computational tasks to remote servers, thereby freeing up local resources and speeding up the overall workflow. By leveraging this node, you can queue jobs on a remote server, manage batch processing, and control the execution flow based on various conditions. The primary goal of the RemoteQueueWorker is to streamline the process of dispatching tasks to remote workers, ensuring that your creative projects are handled efficiently and effectively.

Queue on remote (worker) Input Parameters:

remote_chain

The remote_chain parameter is a required input that represents the chain of tasks or operations to be executed on the remote worker. It is of type REMCHAIN, which is a custom data type specific to the node's functionality. This parameter ensures that the sequence of operations is maintained and executed correctly on the remote server.

remote_url

The remote_url parameter specifies the URL of the remote server where the jobs will be dispatched. It is a string input with a default value of http://127.0.0.1:8288/. This parameter allows you to define the endpoint for the remote worker, ensuring that the jobs are sent to the correct server for processing. The URL should be a valid and accessible endpoint.

batch_override

The batch_override parameter is an integer input that allows you to override the default batch size for processing tasks. It has a default value of 0, with a minimum value of 0 and a maximum value of 8. This parameter enables you to control the number of tasks processed in a single batch, providing flexibility in managing workload distribution.

enabled

The enabled parameter is a selection input with options true, false, and remote, and a default value of true. This parameter determines whether the job should be executed locally, remotely, or not at all. Setting it to true enables local execution, false disables execution, and remote enables remote execution.

outputs

The outputs parameter is a selection input with options final_image and any, and a default value of final_image. This parameter specifies the type of output expected from the remote job. It allows you to define the desired output format, ensuring that the results are returned in the appropriate form.

Queue on remote (worker) Output Parameters:

remote_chain

The remote_chain output is of type REMCHAIN and represents the updated chain of tasks after being processed by the remote worker. This output ensures that the sequence of operations is maintained and can be further used in subsequent nodes or processes.

remote_info

The remote_info output is of type REMINFO and provides information about the remote job, including the remote_url and job_id. This output is essential for tracking the status and details of the dispatched job, allowing you to monitor and manage remote tasks effectively.

Queue on remote (worker) Usage Tips:

• Ensure that the remote_url is correctly configured to point to an accessible and operational remote server to avoid connectivity issues.
• Use the batch_override parameter to optimize the batch size based on the capabilities of the remote server, balancing workload and performance.
• Set the enabled parameter to remote when you want to offload tasks to the remote server, and to false if you need to temporarily disable job execution without removing the node.

Queue on remote (worker) Common Errors and Solutions:

"ConnectionError: Failed to connect to remote server"

• Explanation: This error occurs when the specified remote_url is not accessible or the server is down.
• Solution: Verify that the remote_url is correct and that the remote server is running and accessible. Check network connectivity and server status.

"ValueError: Invalid batch size"

• Explanation: This error occurs when the batch_override parameter is set to a value outside the allowed range (0-8).
• Solution: Ensure that the batch_override value is within the valid range. Adjust the value to be between 0 and 8.

"KeyError: Missing required input 'remote_chain'"

• Explanation: This error occurs when the remote_chain input is not provided or is incorrectly formatted.
• Solution: Ensure that the remote_chain input is correctly specified and contains the necessary task sequence information. Verify the format and content of the remote_chain data.