Function _postprocess_common

verl/verl/utils/transferqueue_utils.py:208–241

Common post-processing logic for function outputs in TransferQueue bridge. This function handles the final return value based on whether data should be put into storage (put_data) and whether collection is needed (need_collect). It ensures proper return types based on the execution cont

(output, put_data, need_collect)

def _postprocess_common(output, put_data, need_collect):
    """Common post-processing logic for function outputs in TransferQueue bridge.

    This function handles the final return value based on whether data should be
    put into storage (put_data) and whether collection is needed (need_collect).
    It ensures proper return types based on the execution context.

    Args:
        output: The original output from the decorated function. Can be any type.
        put_data: bool, indicating whether the output should be put into TransferQueue.
                 If True, output will be put to TQ and return the corresponding BatchMeta;
                 if False, output will not be put into TQ.
        need_collect: bool, indicating whether this process needs to collect data.
                     If False, the output will be replaced by an empty BatchMeta or DataProto
                     to avoid redundant communication.

    Returns:
        - BatchMeta.empty(): When put_data=True but need_collect=False, indicating
          no data should be stored but BatchMeta structure is expected.
        - DataProto(): When put_data=False, need_collect=False, and output is DataProto,
          returning an empty DataProto.
        - output: In all other cases, returns the original output unchanged.

    Note:
        This function is used in the tqbridge decorator to normalize return values
        across different execution paths and avoid redundant data operations in
        distributed scenarios.
    """
    if put_data and not need_collect:
        return BatchMeta.empty()
    elif not put_data and not need_collect and isinstance(output, DataProto):
        return DataProto()
    else:
        return output


def tqbridge(dispatch_mode: "dict | Dispatch" = None, put_data: bool = True):