Add Save/Delete character buttons (#1870)

---------

Co-authored-by: oobabooga <112222186+oobabooga@users.noreply.github.com>

modules/chat.py

@@ -602,3 +602,43 @@ def upload_your_profile_picture(img):
         img = make_thumbnail(img)
         img.save(Path('cache/pfp_me.png'))
         logging.info('Profile picture saved to "cache/pfp_me.png"')
+
+
+def delete_file(path):
+    if path.exists():
+        logging.warning(f'Deleting {path}')
+        path.unlink(missing_ok=True)
+
+
+def save_character(name, greeting, context, picture, filename, instruct=False):
+    if filename == "":
+        logging.error("The filename is empty, so the character will not be saved.")
+        return
+
+    folder = 'characters' if not instruct else 'characters/instruction-following'
+    data = {
+        'name': name,
+        'greeting': greeting,
+        'context': context,
+    }
+
+    data = {k: v for k, v in data.items() if v}  # Strip falsy
+    filepath = Path(f'{folder}/{filename}.yaml')
+    with filepath.open('w') as f:
+        yaml.dump(data, f)
+
+    logging.info(f'Wrote {filepath}')
+    path_to_img = Path(f'{folder}/{filename}.png')
+    if picture and not instruct:
+        picture.save(path_to_img)
+        logging.info(f'Wrote {path_to_img}')
+    elif path_to_img.exists():
+        delete_file(path_to_img)
+
+
+def delete_character(name, instruct=False):
+    folder = 'characters' if not instruct else 'characters/instruction-following'
+    for extension in ["yml", "yaml", "json"]:
+        delete_file(Path(f'{folder}/{name}.{extension}'))
+
+    delete_file(Path(f'{folder}/{name}.png'))

modules/ui.py

@@ -15,6 +15,9 @@ with open(Path(__file__).resolve().parent / '../css/chat.js', 'r') as f:
     chat_js = f.read()
 
 refresh_symbol = '\U0001f504'  # 🔄
+delete_symbol = '🗑️'
+save_symbol = '💾'
+
 theme = gr.themes.Default(
     font=['Helvetica', 'ui-sans-serif', 'system-ui', 'sans-serif'],
     font_mono=['IBM Plex Mono', 'ui-monospace', 'Consolas', 'monospace'],
@@ -89,3 +92,11 @@ def create_refresh_button(refresh_component, refresh_method, refreshed_args, ele
         outputs=[refresh_component]
     )
     return refresh_button
+
+
+def create_delete_button(**kwargs):
+    return ToolButton(value=delete_symbol, **kwargs)
+
+
+def create_save_button(**kwargs):
+    return ToolButton(value=save_symbol, **kwargs)

server.py

@@ -581,12 +581,20 @@ def create_interface():
                 shared.gradio['chat_style'] = gr.Dropdown(choices=utils.get_available_chat_styles(), label='Chat style', value=shared.settings['chat_style'], visible=shared.settings['mode'] != 'instruct')
 
             with gr.Tab('Chat settings', elem_id='chat-settings'):
+                with gr.Row():
+                    with gr.Column(scale=8):
                         with gr.Row():
                             shared.gradio['character_menu'] = gr.Dropdown(choices=utils.get_available_characters(), label='Character', elem_id='character-menu', info='Used in chat and chat-instruct modes.')
                             ui.create_refresh_button(shared.gradio['character_menu'], lambda: None, lambda: {'choices': utils.get_available_characters()}, 'refresh-button')
+                            shared.gradio['save_character'] = ui.create_save_button(elem_id='refresh-button')
+                            shared.gradio['delete_character'] = ui.create_delete_button(elem_id='refresh-button')
+
+                        shared.gradio['save_character-filename'] = gr.Textbox(lines=1, label='File name:', interactive=True, visible=False)
+                        shared.gradio['save_character-confirm'] = gr.Button('Confirm save character', elem_classes="small-button", variant='primary', visible=False)
+                        shared.gradio['save_character-cancel'] = gr.Button('Cancel', elem_classes="small-button", visible=False)
+                        shared.gradio['delete_character-confirm'] = gr.Button('Confirm delete character', elem_classes="small-button", variant='stop', visible=False)
+                        shared.gradio['delete_character-cancel'] = gr.Button('Cancel', elem_classes="small-button", visible=False)
 
-                with gr.Row():
-                    with gr.Column(scale=8):
                         shared.gradio['name1'] = gr.Textbox(value=shared.settings['name1'], lines=1, label='Your name')
                         shared.gradio['name2'] = gr.Textbox(value=shared.settings['name2'], lines=1, label='Character\'s name')
                         shared.gradio['context'] = gr.Textbox(value=shared.settings['context'], lines=4, label='Context')
@@ -596,7 +604,10 @@ def create_interface():
                         shared.gradio['character_picture'] = gr.Image(label='Character picture', type='pil')
                         shared.gradio['your_picture'] = gr.Image(label='Your picture', type='pil', value=Image.open(Path('cache/pfp_me.png')) if Path('cache/pfp_me.png').exists() else None)
 
+                with gr.Row():
                     shared.gradio['instruction_template'] = gr.Dropdown(choices=utils.get_available_instruction_templates(), label='Instruction template', value='None', info='Change this according to the model/LoRA that you are using. Used in instruct and chat-instruct modes.')
+                    ui.create_refresh_button(shared.gradio['instruction_template'], lambda: None, lambda: {'choices': utils.get_available_instruction_templates()}, 'refresh-button')
+
                 shared.gradio['name1_instruct'] = gr.Textbox(value='', lines=2, label='User string')
                 shared.gradio['name2_instruct'] = gr.Textbox(value='', lines=1, label='Bot string')
                 shared.gradio['context_instruct'] = gr.Textbox(value='', lines=4, label='Context')
@@ -831,7 +842,6 @@ def create_interface():
                 lambda x: gr.update(visible=x != 'instruct'), shared.gradio['mode'], shared.gradio['chat_style'], show_progress=False).then(
                 chat.redraw_html, shared.reload_inputs, shared.gradio['display'])
 
-
             shared.gradio['chat_style'].change(chat.redraw_html, shared.reload_inputs, shared.gradio['display'])
             shared.gradio['instruction_template'].change(
                 partial(chat.load_character, instruct=True), [shared.gradio[k] for k in ['instruction_template', 'name1_instruct', 'name2_instruct']], [shared.gradio[k] for k in ['name1_instruct', 'name2_instruct', 'dummy', 'dummy', 'context_instruct', 'turn_template']])
@@ -848,6 +858,31 @@ def create_interface():
                 chat.save_history, shared.gradio['mode'], None, show_progress=False).then(
                 chat.redraw_html, shared.reload_inputs, shared.gradio['display'])
 
+            # Save/delete a character
+            shared.gradio['save_character'].click(
+                lambda x: x, shared.gradio['name2'], shared.gradio['save_character-filename'], show_progress=True).then(
+                lambda: [gr.update(visible=True)] * 3, None, [shared.gradio[k] for k in ['save_character-filename', 'save_character-confirm', 'save_character-cancel']], show_progress=False)
+
+            shared.gradio['save_character-cancel'].click(
+                lambda: [gr.update(visible=False)] * 3, None, [shared.gradio[k] for k in ['save_character-filename', 'save_character-confirm', 'save_character-cancel']], show_progress=False)
+
+            shared.gradio['save_character-confirm'].click(
+                partial(chat.save_character, instruct=False), [shared.gradio[k] for k in ['name2', 'greeting', 'context', 'character_picture', 'save_character-filename']], None).then(
+                lambda: [gr.update(visible=False)] * 3, None, [shared.gradio[k] for k in ['save_character-filename', 'save_character-confirm', 'save_character-cancel']], show_progress=False).then(
+                lambda x: x, shared.gradio['save_character-filename'], shared.gradio['character_menu'])
+
+            shared.gradio['delete_character'].click(
+                lambda: [gr.update(visible=True)] * 2, None, [shared.gradio[k] for k in ['delete_character-confirm', 'delete_character-cancel']], show_progress=False)
+
+            shared.gradio['delete_character-cancel'].click(
+                lambda: [gr.update(visible=False)] * 2, None, [shared.gradio[k] for k in ['delete_character-confirm', 'delete_character-cancel']], show_progress=False)
+
+            shared.gradio['delete_character-confirm'].click(
+                partial(chat.delete_character, instruct=False), shared.gradio['character_menu'], None).then(
+                lambda: gr.update(choices=utils.get_available_characters()), outputs=shared.gradio['character_menu']).then(
+                lambda: 'None', None, shared.gradio['character_menu']).then(
+                lambda: [gr.update(visible=False)] * 2, None, [shared.gradio[k] for k in ['delete_character-confirm', 'delete_character-cancel']], show_progress=False)
+
             shared.gradio['download_button'].click(lambda x: chat.save_history(x, timestamp=True), shared.gradio['mode'], shared.gradio['download'])
             shared.gradio['Upload character'].click(chat.upload_character, [shared.gradio['upload_json'], shared.gradio['upload_img_bot']], [shared.gradio['character_menu']])
             shared.gradio['character_menu'].change(