# Copyright (c) ModelScope Contributors. All rights reserved. import gradio as gr from typing import Type from ..base import BaseUI class Rollout(BaseUI): group = 'llm_grpo' locale_dict = { 'num_generations': { 'label': { 'zh': '采样数量', 'en': 'Number of samples' }, 'info': { 'zh': '每个prompt采样的数量,即论文中的G值', 'en': 'The number of samples for each prompt, that is, the G value in the paper' } }, 'max_completion_length': { 'label': { 'zh': '最大生成长度', 'en': 'Max completion length' }, 'info': { 'zh': 'GRPO算法中的最大生成长度', 'en': 'Maximum generation length in GRPO algorithm' } }, 'async_generate': { 'label': { 'zh': '异步生成', 'en': 'Async generate' }, 'info': { 'zh': '异步rollout以提高训练速度', 'en': 'Asynchronous rollout to increase training speed' } }, 'temperature': { 'label': { 'zh': '采样温度', 'en': 'Temperature' }, }, 'top_k': { 'label': { 'zh': 'Top-k', 'en': 'Top-k' }, }, 'top_p': { 'label': { 'zh': 'Top-p', 'en': 'Top-p' }, }, 'repetition_penalty': { 'label': { 'zh': '重复惩罚', 'en': 'Repetition Penalty' }, }, 'use_vllm': { 'label': { 'zh': '使用vLLM', 'en': 'Using vLLM' }, 'info': { 'zh': '是否使用vLLM作为GRPO生成的推理后端', 'en': 'Whether to use vLLM as the infer_backend of generation by GRPO' } }, 'vllm_mode': { 'label': { 'zh': 'vLLM集成模式', 'en': 'vLLM Integration Mode' }, 'info': { 'zh': 'Server模式使用`swift rollout`拉起的vLLM服务进行采样;Colocate模式使用程序内部署的vLLM', 'en': 'Server mode uses the vLLM server deployed by swift rollout for sampling,' ' colocate mode uses vLLM deployed in the program' } }, 'vllm_gpu_memory_utilization': { 'label': { 'zh': 'GPU显存利用率', 'en': 'GPU memory utilization' }, 'info': { 'zh': 'vLLM透传参数', 'en': 'vLLM transparent transmission parameters' } }, 'vllm_tensor_parallel_size': { 'label': { 'zh': '张量并行大小', 'en': 'Tensor parallel size' }, 'info': { 'zh': 'vLLM透传参数', 'en': 'vLLM transparent transmission parameters' } }, 'vllm_max_model_len': { 'label': { 'zh': '模型支持的最大长度', 'en': 'Max model len' }, 'info': { 'zh': 'vLLM透传参数', 'en': 'vLLM transparent transmission parameters' } }, 'sleep_level': { 'label': { 'zh': 'Sleep level', 'en': 'Sleep level' }, 'info': { 'zh': '训练时释放vLLM显存', 'en': 'Release vLLM memory during training' } }, 'vllm_server_host': { 'label': { 'zh': 'vLLM服务主机', 'en': 'vLLM server host' }, }, 'vllm_server_port': { 'label': { 'zh': 'vLLM服务端口', 'en': 'vLLM server port' }, }, 'vllm_server_timeout': { 'label': { 'zh': '服务超时时间', 'en': 'Server timeout' }, 'info': { 'zh': '连接vLLM服务的超时时间', 'en': 'Timeout for connecting to vLLM server' } }, 'offload_model': { 'label': { 'zh': '卸载模型', 'en': 'Offload model' }, 'info': { 'zh': '是否在vLLM推理时卸载模型', 'en': 'Whether to offload the model during vLLM inference' } }, 'offload_optimizer': { 'label': { 'zh': '卸载优化器', 'en': 'Offload optimizer' }, 'info': { 'zh': '是否在vLLM推理时卸载优化器参数', 'en': 'Whether to offload optimizer parameters during vLLM inference' } }, 'colocate_param': { 'label': { 'zh': 'Colocate模式参数', 'en': 'Colocate mode parameters' } }, 'server_param': { 'label': { 'zh': 'Server模式参数', 'en': 'Server mode parameters' } }, 'rollout_param': { 'label': { 'zh': 'Rollout设置(更多参数->GRPO高级参数设置)', 'en': 'Rollout settings(more params->GRPO advanced settings)' } } } tabs_to_filter = { 'colocate': [ 'vllm_enable_prefix_caching', 'vllm_gpu_memory_utilization', 'vllm_tensor_parallel_size', 'vllm_max_model_len', 'sleep_level', 'offload_model', 'offload_optimizer' ], 'server': ['async_generate', 'vllm_server_host', 'vllm_server_port', 'vllm_server_timeout'], 'llm_rollout': ['tensor_parallel_size', 'data_parallel_size', 'max_model_len', 'gpu_memory_utilization', 'port'] } @classmethod def do_build_ui(cls, base_tab: Type['BaseUI']): with gr.Accordion(elem_id='rollout_param', open=False): with gr.Row(): gr.Slider(elem_id='temperature', minimum=0.0, maximum=10, step=0.1, value=1.0) gr.Slider(elem_id='top_k', minimum=1, maximum=100, step=5, value=80) gr.Slider(elem_id='top_p', minimum=0.0, maximum=1.0, step=0.05, value=1.0) gr.Slider(elem_id='repetition_penalty', minimum=0.0, maximum=10, step=0.05, value=1.05) with gr.Row(): gr.Checkbox(elem_id='use_vllm', value=True, scale=4) gr.Dropdown(elem_id='vllm_mode', choices=['colocate', 'server'], scale=4) gr.Slider(elem_id='num_generations', minimum=1, maximum=64, step=1, scale=4) gr.Textbox(elem_id='max_completion_length', lines=1, value='512', scale=4) with gr.Accordion(elem_id='colocate_param', open=True): with gr.Row(): gr.Textbox(elem_id='vllm_gpu_memory_utilization', lines=1, value='0.5', scale=4) gr.Textbox(elem_id='vllm_tensor_parallel_size', lines=1, value='1', scale=4) gr.Textbox(elem_id='vllm_max_model_len', lines=1, value='', scale=4) gr.Dropdown(elem_id='sleep_level', choices=['0', '1'], value='0', scale=4, allow_custom_value=True) gr.Checkbox(elem_id='offload_model', value=True, scale=4) gr.Checkbox(elem_id='offload_optimizer', value=True, scale=4) with gr.Accordion(elem_id='server_param', open=True): with gr.Row(): gr.Checkbox(elem_id='async_generate', scale=4) gr.Textbox(elem_id='vllm_server_host', value='127.0.0.1', scale=4) gr.Textbox(elem_id='vllm_server_port', lines=1, scale=4) gr.Textbox(elem_id='vllm_server_timeout', lines=1, scale=4, value=120) @staticmethod def update_num_gen(per_device_batch_size, steps_per_generation, num_processes): return int(per_device_batch_size) * int(steps_per_generation) * int(num_processes)