starvector/serve/gradio_web_server.py

import argparse
import datetime
import json
import os
import time
import gradio as gr
import requests
from starvector.serve.conversation import default_conversation
from starvector.serve.constants import LOGDIR, CLIP_QUERY_LENGTH
from starvector.serve.util import (build_logger, server_error_msg)

logger = build_logger("gradio_web_server", "gradio_web_server.log")
headers = {"User-Agent": "StarVector Client"}

no_change_btn = gr.Button.update()
enable_btn = gr.Button.update(interactive=True)
disable_btn = gr.Button.update(interactive=False)

priority = {
    "starvector-1b-im2svg": "aaaaaaa",
}

def get_conv_log_filename():
    t = datetime.datetime.now()
    name = os.path.join(LOGDIR, f"{t.year}-{t.month:02d}-{t.day:02d}-conv.json")
    return name

def get_model_list():
    ret = requests.post(args.controller_url + "/refresh_all_workers")
    assert ret.status_code == 200
    ret = requests.post(args.controller_url + "/list_models")
    models = ret.json()["models"]
    models.sort(key=lambda x: priority.get(x, x))
    logger.info(f"Models: {models}")
    return models

def load_demo(url_params, request: gr.Request):
    logger.info(f"load_demo. ip: {request.client.host}. params: {url_params}")

    dropdown_update = gr.Dropdown.update(visible=True)
    if "model" in url_params:
        model = url_params["model"]
        if model in models:
            dropdown_update = gr.Dropdown.update(
                value=model, visible=True)

    state = default_conversation.copy()
    return state, dropdown_update

mapping_model_task = {
    'Image2SVG': 'im2svg',
    'Text2SVG': 'text2svg'
}

def get_models_dropdown_from_task(task):
    models = get_model_list()
    models = [model for model in models if mapping_model_task[task] in model]
    dropdown_update = gr.Dropdown.update(
        choices=models,
        value=models[0] if len(models) > 0 else ""
    )
    return dropdown_update
    

def load_demo_refresh_model_list(task, request: gr.Request):
    logger.info(f"load_demo. ip: {request.client.host}")
    dropdown_update = get_models_dropdown_from_task(task)
    state = default_conversation.copy()
    return state, dropdown_update

def vote_last_response(state, vote_type, model_selector, request: gr.Request):
    with open(get_conv_log_filename(), "a") as fout:
        data = {
            "tstamp": round(time.time(), 4),
            "type": vote_type,
            "model": model_selector,
            "state": state.dict(),
            "ip": request.client.host,
        }
        fout.write(json.dumps(data) + "\n")

def upvote_last_response(state, model_selector, request: gr.Request):
    logger.info(f"upvote. ip: {request.client.host}")
    vote_last_response(state, "upvote", model_selector, request)
    return ("",) + (disable_btn,) * 7

def downvote_last_response(state, model_selector, request: gr.Request):
    logger.info(f"downvote. ip: {request.client.host}")
    vote_last_response(state, "downvote", model_selector, request)
    return ("",) + (disable_btn,) * 7

def flag_last_response(state, model_selector, request: gr.Request):
    logger.info(f"flag. ip: {request.client.host}")
    vote_last_response(state, "flag", model_selector, request)
    return ("",) + (disable_btn,) * 7

def regenerate(state, image_process_mode, request: gr.Request):
    logger.info(f"regenerate. ip: {request.client.host}")
    state.messages[-1][-1] = None
    prev_human_msg = state.messages[-2]
    if type(prev_human_msg[1]) in (tuple, list):
        prev_human_msg[1] = (prev_human_msg[1][:2], image_process_mode)
    state.skip_next = False
    return (state, None, None, None) + (disable_btn,) * 7

def clear_history(request: gr.Request):
    logger.info(f"clear_history. ip: {request.client.host}")
    state = default_conversation.copy()
    return (state, None, None) + (disable_btn,) * 7

def send_data(state, image, image_process_mode, text_caption, task, request: gr.Request):
    logger.info(f"send_data. ip: {request.client.host}.")
    if task == 'Image2SVG':
        if image is None:
            state.skip_next = True
            return (state, None, None, image) + (no_change_btn,) * 7

        if image is not None:
            image_message = (image, image_process_mode)
        state.append_message(state.roles[0], image_message)
        state.append_message(state.roles[1], "▌")
        state.skip_next = False
        msg = state.to_gradio_svg_code()[0][1]
        return (state, msg, state.to_gradio_svg_render(), image) + (no_change_btn,) * 7
    else:
        if text_caption is None:
            state.skip_next = True
            return (state, None, None, image) + (no_change_btn,) * 7

        state.append_message(state.roles[0], text_caption)
        state.append_message(state.roles[1], "▌")
        state.skip_next = False
        msg = state.to_gradio_svg_code()[0][1]
        return (state, msg, state.to_gradio_svg_render(), image) + (no_change_btn,) * 7

def download_files(state, request: gr.Request):
    logger.info(f"download_files. ip: {request.client.host}")
    svg_str, image = state.download_files()
    
    # TODO: Figure out how to download the SVG in the users browser, idk how to do it now 
            
def update_task(task):
    dropdown_update = get_models_dropdown_from_task(task)

    if task == "Text2SVG":
        return 1.0, 0.9, 0.95, dropdown_update
    else:
        return 0.6, 0.9, 0.95, dropdown_update
    
    
def stop_sampling(state, image, request: gr.Request):
    logger.info(f"stop_sampling. ip: {request.client.host}")
    state.stop_sampling = True
    return (state, None, None, image) + (disable_btn,) * 7

def http_bot(state, task_selector, text_caption, model_selector, num_beams, temperature, len_penalty, top_p, max_new_tokens, request: gr.Request):
    logger.info(f"http_bot. ip: {request.client.host}")
    start_tstamp = time.time()
    model_name = model_selector

    if state.skip_next:
        # This generate call is skipped due to invalid inputs
        yield (state, None, None) + (no_change_btn,) * 7
        return

    # Query worker address
    controller_url = args.controller_url
    ret = requests.post(controller_url + "/get_worker_address",
            json={"model": model_name})
    worker_addr = ret.json()["address"]
    logger.info(f"model_name: {model_name}, worker_addr: {worker_addr}")

    # No available worker
    if worker_addr == "":
        state.messages[-1][-1] = server_error_msg
        yield (state, None, None, disable_btn, disable_btn, disable_btn, enable_btn, enable_btn, disable_btn, disable_btn)
        return

    # Construct prompt
    if task_selector == "Image2SVG":
        prompt = state.get_image_prompt()
    else:
        prompt = text_caption

    # Make requests
    pload = {
        "model": model_name,
        "prompt": prompt,
        "num_beams": int(num_beams),
        "temperature": float(temperature),
        "len_penalty": float(len_penalty),
        "top_p": float(top_p),
        "max_new_tokens": min(int(max_new_tokens), 8192-CLIP_QUERY_LENGTH),
    }
    logger.info(f"==== request ====\n{pload}")

    pload['images'] = state.get_images()

    state.messages[-1][-1] = "▌"
    yield (state, state.messages[-1][-1], state.to_gradio_svg_render()) + (disable_btn, disable_btn, disable_btn, disable_btn, disable_btn, enable_btn, enable_btn)

    try:
        # Stream output
        if state.stop_sampling:
            state.messages[1][-1] = "▌"
            yield (state, state.messages[-1][-1], state.to_gradio_svg_render()) + (disable_btn, disable_btn, disable_btn, enable_btn, enable_btn, disable_btn, enable_btn)
            return
        
        response = requests.post(worker_addr + "/worker_generate_stream",
            headers=headers, json=pload, stream=True, timeout=10)
        for chunk in response.iter_lines(decode_unicode=False, delimiter=b"\0"):
            if chunk:
                data = json.loads(chunk.decode())
                if data["error_code"] == 0:
                    # output = data["text"].strip().replace('<', '&lt;').replace('>', '&gt;') # trick to avoid the SVG getting rendered
                    output = data["text"].strip()
                    state.messages[-1][-1] = output + "▌"
                    st = state.to_gradio_svg_code()
                    yield (state, st[-1][1], state.to_gradio_svg_render()) + (disable_btn, disable_btn, disable_btn, enable_btn, enable_btn, enable_btn, enable_btn)
                else:
                    output = data["text"] + f" (error_code: {data['error_code']})"
                    state.messages[-1][-1] = output
                    
                    yield (state, st[-1][1], state.to_gradio_svg_render()) + (disable_btn, disable_btn, disable_btn, enable_btn, enable_btn, disable_btn, disable_btn)
                    return
                time.sleep(0.03)
    except requests.exceptions.RequestException as e:
        state.messages[-1][-1] = server_error_msg
        yield (state, None, None) + (disable_btn, disable_btn, disable_btn, enable_btn, enable_btn, disable_btn, disable_btn)
        return

    yield (state, state.messages[-1][-1], state.to_gradio_svg_render()) + (enable_btn,) * 7

    finish_tstamp = time.time()
    logger.info(f"{output}")

    with open(get_conv_log_filename(), "a") as fout:
        data = {
            "tstamp": round(finish_tstamp, 4),
            "type": "chat",
            "model": model_name,
            "start": round(start_tstamp, 4),
            "finish": round(finish_tstamp, 4),
            "svg": state.messages[-1][-1],
            "ip": request.client.host,
        }
        fout.write(json.dumps(data) + "\n")

title_markdown = ("""
# 💫 StarVector: Generating Scalable Vector Graphics Code from Images and Text

[[Project Page](https://starvector.github.io)] [[Code](https://github.com/joanrod/star-vector)] [[Model](https://huggingface.co/joanrodai/starvector-1.4b)] | 📚 [[StarVector](https://arxiv.org/abs/2312.11556)]""")

sub_title_markdown = ("""**How does it work?** Select the task you want to perform, and the model will be automatically set. For **Text2SVG**, introduce a prompt in Text Caption. For **Image2SVG**, select an image and vectorize it. \ 
**Note**: The current model works on vector-like images like icons and or vector-like designs.""")
tos_markdown = ("""
### Terms of use
By using this service, users are required to agree to the following terms:
The service is a research preview intended for non-commercial use only. It only provides limited safety measures and may generate offensive content. It must not be used for any illegal, harmful, violent, racist, or sexual purposes. The service may collect user dialogue data for future research.
Please click the "Flag" button if you get any inappropriate answer! We will collect those to keep improving our moderator.
For an optimal experience, please use desktop computers for this demo, as mobile devices may compromise its quality.
""")

learn_more_markdown = ("""
### License
The service is a research preview intended for non-commercial use only. Please contact us if you find any potential violation.
""")

block_css = """

#buttons button {
    min-width: min(120px,100%);
}

.gradio-container{
    max-width: 1200px!important
}

.ͼ1 .cm-content {
    white-space: unset !important; 
    flex-shrink: unset !important;
}

.ͼ2p .cm-scroller {
    max-height: 200px;
    overflow: scroll;
}

#svg_render{
    padding: 20px !important;
}

#submit_btn{
    max-height: 40px;
}

.selector{
    max-height: 100px;
}
h1{display: flex;align-items: center;justify-content: center;gap: .25em}
*{transition: width 0.5s ease, flex-grow 0.5s ease}
"""
def build_demo(embed_mode):
    svg_render = gr.Image(label="Rendered SVG", elem_id='svg_render', height=300)
    svg_code = gr.Code(label="SVG Code", elem_id='svg_code', interactive=True, lines=5)

    with gr.Blocks(title="StarVector", theme=gr.themes.Default(), css=block_css) as demo:
        state = gr.State()
        if not embed_mode:
            gr.Markdown(title_markdown)
            gr.Markdown(sub_title_markdown)
        with gr.Row():
            with gr.Column(scale=4):
                task_selector = gr.Dropdown(
                    choices=["Image2SVG", "Text2SVG"],
                    value="Image2SVG",
                    label="Task",
                    interactive=True,
                    show_label=True,
                    container=True,
                    elem_id="task_selector",
                    elem_classes=["selector"],
                )
                model_selector = gr.Dropdown(
                    choices=models,
                    value=models[0] if len(models) > 0 else "",
                    label="Model",
                    interactive=True,
                    show_label=True,
                    container=True,
                    elem_classes=["selector"],
                )
                    
                imagebox = gr.Image(type="pil", visible=True, elem_id="imagebox")
                image_process_mode = gr.Radio(
                    ["Resize", "Pad", "Default"],
                    value="Pad",
                    label="Preprocess for non-square image", visible=False)
                
                # Text input
                text_caption = gr.Textbox(label="Text Caption", visible=True, value="The icon of a yellow star", elem_id="text_caption")
                
                cur_dir = os.path.dirname(os.path.abspath(__file__))
                gr.Examples(examples=[
                    [f"{cur_dir}/examples/sample-4.png"],
                    [f"{cur_dir}/examples/sample-7.png"],
                    [f"{cur_dir}/examples/sample-16.png"],
                    [f"{cur_dir}/examples/sample-17.png"],
                    [f"{cur_dir}/examples/sample-18.png"],
                    [f"{cur_dir}/examples/sample-0.png"],
                    [f"{cur_dir}/examples/sample-1.png"],
                    [f"{cur_dir}/examples/sample-6.png"],
                ], inputs=[imagebox], elem_id="examples")
                
                submit_btn = gr.Button(value="Send", variant="primary", elem_id="submit_btn", interactive=True)

                with gr.Accordion("Parameters", open=False):
                    num_beams = gr.Slider(minimum=1, maximum=10, value=1, step=1, interactive=True, label="Num Beams", visible=False,)
                    temperature = gr.Slider(minimum=0.0, maximum=2.0, value=0.9, step=0.05, interactive=True, label="Temperature",)
                    len_penalty = gr.Slider(minimum=0.0, maximum=2.0, value=0.6, step=0.05, interactive=True, label="Length Penalty",)
                    top_p = gr.Slider(minimum=0.0, maximum=1.0, value=0.95, step=0.05, interactive=True, label="Top P",)
                    max_output_tokens = gr.Slider(minimum=0, maximum=1024, value=1024, step=64, interactive=True, label="Max output tokens",)

            with gr.Column(scale=9):
                with gr.Row():
                    svg_code.render()
                with gr.Row():
                    svg_render.render()

                with gr.Row(elem_id="buttons") as button_row:
                    upvote_btn = gr.Button(value="👍  Upvote", interactive=False)
                    downvote_btn = gr.Button(value="👎  Downvote", interactive=False)
                    flag_btn = gr.Button(value="⚠️  Flag", interactive=False)
                    stop_btn = gr.Button(value="⏹️  Stop Generation", interactive=False, visible=False)
                    regenerate_btn = gr.Button(value="🔄  Regenerate", interactive=False, visible=False)
                    clear_btn = gr.Button(value="🗑️  Clear", interactive=False)  
                    download_btn = gr.Button(value="Download SVG", interactive=False, visible=False)           

        if not embed_mode:
            gr.Markdown(tos_markdown)
            gr.Markdown(learn_more_markdown)
        url_params = gr.JSON(visible=False)

        # Register listeners
        btn_list = [upvote_btn, downvote_btn, flag_btn, regenerate_btn, clear_btn, stop_btn, download_btn]
        upvote_btn.click(
            upvote_last_response,
            [state, model_selector],
            [upvote_btn, downvote_btn, flag_btn],
            queue=False
        )
        downvote_btn.click(
            downvote_last_response,
            [state, model_selector],
            [upvote_btn, downvote_btn, flag_btn],
            queue=False
        )
        flag_btn.click(
            flag_last_response,
            [state, model_selector],
            [upvote_btn, downvote_btn, flag_btn],
            queue=False
        )

        regenerate_btn.click(
            regenerate,
            [state, image_process_mode],
            [state, svg_code, svg_render, imagebox] + btn_list,
            queue=False
        ).then(
            http_bot,
            [state, task_selector, text_caption, model_selector, num_beams, temperature, len_penalty,  top_p, max_output_tokens],
            [state, svg_code, svg_render] + btn_list)

        submit_btn.click(
            send_data,
            [state, imagebox, image_process_mode, text_caption, task_selector],
            [state, svg_code, svg_render, imagebox] + btn_list,
            queue=False
        ).then(
            http_bot,
            [state, task_selector, text_caption, model_selector, num_beams, temperature, len_penalty, top_p, max_output_tokens],
            [state, svg_code, svg_render] + btn_list
        )

        clear_btn.click(
            clear_history,
            None,
            [state, svg_code, svg_render] + btn_list,
            queue=False
        )

        stop_btn.click(
            stop_sampling,
            [state, imagebox],
            [state, imagebox] + btn_list,
            queue=False
        ).then(
            clear_history,
            None,
            [state, svg_code, svg_render] + btn_list,
            queue=False
        )
        
        download_btn.click(
            download_files,
            [state],
            None,
            queue=False
        )
        task_selector.change(
            update_task,            
            inputs=[task_selector],
            outputs=[len_penalty, temperature, top_p, model_selector],
            queue=False,
            _js="""
                    function(task) {
                        var imageBoxElement = document.getElementById("imagebox");
                        var textCaptionElement = document.getElementById("text_caption");
                        var examplesElement = document.getElementById("examples");
                        if (task === "Text2SVG") {
                            imageBoxElement.style.display = "none";
                            textCaptionElement.style.display = "block";
                            examplesElement.style.display = "none";
                        } else if (task === "Image2SVG") {
                            imageBoxElement.style.display = "block";
                            textCaptionElement.style.display = "none";
                            examplesElement.style.display = "block";
                        }
                        return task;
                    }
                """
        )
        
        if args.model_list_mode == "once":
            demo.load(
                load_demo,
                [url_params, task_selector],
                [state, model_selector],
                _js="""
                    function() {
                        const params = new URLSearchParams(window.location.search);
                        url_params = Object.fromEntries(params);
                        console.log(url_params);
                        return url_params;
                        
                        }
                    """,
                queue=False
            )
        elif args.model_list_mode == "reload":
            demo.load(
                load_demo_refresh_model_list,
                [task_selector],
                [state, model_selector],
                _js="""
                    function(task) {
                        var textCaptionElement = document.getElementById("text_caption");
                        var autoScrollBottom = true;
                        textCaptionElement.style.display = "none";
                        function updateScroll(){
                            if (autoScrollBottom) {
                                var element = document.getElementsByClassName("cm-scroller")[0];
                                element.scrollTop = element.scrollHeight;
                            }
                        }
                        function handleScroll() {
                            var element = document.getElementsByClassName("cm-scroller")[0];
                            //if (element.scrollHeight - element.scrollTop === element.clientHeight) {
                            if (element.scrollHeight - (element.scrollTop + element.clientHeight) < 0.2*(element.scrollTop)) {
                                // User has scrolled to the bottom, enable auto-scrolling
                                autoScrollBottom = true;
                                console.log("bottom");
                            } else {
                                console.log("not bottom");
                                // User has scrolled away from the bottom, disable auto-scrolling
                                autoScrollBottom = false;
                            }
                        }
                        setInterval(updateScroll,500);
                        var element = document.getElementsByClassName("cm-scroller")[0];
                        element.addEventListener("scroll", handleScroll);
    
                        return task;
                    }

                    """,
                queue=False,
            )
                
        else:
            raise ValueError(f"Unknown model list mode: {args.model_list_mode}")

    return demo

if __name__ == "__main__":
    
    parser = argparse.ArgumentParser()
    parser.add_argument("--host", type=str, default="0.0.0.0")
    parser.add_argument("--port", type=int)
    parser.add_argument("--controller-url", type=str, default="http://localhost:21001")
    parser.add_argument("--concurrency-count", type=int, default=10)
    parser.add_argument("--model-list-mode", type=str, default="once",
        choices=["once", "reload"])
    parser.add_argument("--share", action="store_true")
    parser.add_argument("--moderate", action="store_true")
    parser.add_argument("--embed", action="store_true")
    args = parser.parse_args()
    logger.info(f"args: {args}")

    models = get_model_list()

    logger.info(args)
    demo = build_demo(args.embed)
    demo.queue(
        concurrency_count=args.concurrency_count,
        api_open=False
    ).launch(
        server_name=args.host,
        server_port=args.port,
        share=args.share
    )