update.

app.py

@@ -10,7 +10,7 @@ from transformers import AutoTokenizer, AutoModelForSeq2SeqLM
 import streamlit as st
 import pandas as pd
 import base64
-
+import json
 
 @st.cache_data
 def render_svg(svg):
@@ -31,12 +31,22 @@ def load_tokenizer(model_name):
     tokenizer = AutoTokenizer.from_pretrained(model_name)
     return tokenizer
 
+@st.cache_resource
+def load_examples():
+    with open("assets/examples.json", "r") as f:
+        examples = json.load(f)
+    return examples
+
+
+# load resources
 with st.spinner(text="Please wait while the model is loading...."):
 
     model = load_model('nafisehNik/girt-t5-base')
     tokenizer = load_tokenizer('nafisehNik/girt-t5-base')
+    examples = load_examples()
 
 
+# create instruction from metadata
 def create_instruction(name, about, title, labels, assignees, headline_type, headline, summary):
     value_list = [name, about, title, labels, assignees, headline_type, headline]
 
@@ -47,6 +57,7 @@ def create_instruction(name, about, title, labels, assignees, headline_type, hea
     instruction = f'name: {value_list[0]}\nabout: {value_list[1]}\ntitle: {value_list[2]}\nlabels: {value_list[3]}\nassignees: {value_list[4]}\nheadlines_type: {value_list[5]}\nheadlines: {value_list[6]}\nsummary: {summary}'
     return instruction
 
+# compute the output
 def compute(sample, top_p, top_k, do_sample, max_length, min_length):
 
     inputs = tokenizer(sample, return_tensors="pt").to('cpu')
@@ -77,10 +88,13 @@ def compute(sample, top_p, top_k, do_sample, max_length, min_length):
 
     return postprocess_text
 
+# load deduplicate icon
 st.markdown("[![Duplicate Space](https://img.shields.io/badge/-Duplicate%20Space-blue?labelColor=white&style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAP5JREFUOE+lk7FqAkEURY+ltunEgFXS2sZGIbXfEPdLlnxJyDdYB62sbbUKpLbVNhyYFzbrrA74YJlh9r079973psed0cvUD4A+4HoCjsA85X0Dfn/RBLBgBDxnQPfAEJgBY+A9gALA4tcbamSzS4xq4FOQAJgCDwV2CPKV8tZAJcAjMMkUe1vX+U+SMhfAJEHasQIWmXNN3abzDwHUrgcRGmYcgKe0bxrblHEB4E/pndMazNpSZGcsZdBlYJcEL9Afo75molJyM2FxmPgmgPqlWNLGfwZGG6UiyEvLzHYDmoPkDDiNm9JR9uboiONcBXrpY1qmgs21x1QwyZcpvxt9NS09PlsPAAAAAElFTkSuQmCC&logoWidth=14)](https://huggingface.co/spaces/nafisehNik/girt-space?duplicate=true)")
 
+# load logo
 render_svg(open("assets/logo.svg").read())
 
+# exapnd sidebar
 st.markdown(
     """
     <style>
@@ -96,35 +110,113 @@ with st.sidebar:
     st.title(" 🔧 Settings")
 
     with st.expander("🏗 Issue Template Inputs", True):
+
+        # choose examples    
+        in_examples = st.selectbox(
+        label = 'You can select one of the following examples and customize it:',
+        options = ('no example', 'bug report', 'feature request', 'question', 'documentation'),
+        index = 1)
+
+        in_name = st.text_input(
+            label = "Name Metadata: ",
+            value = examples[in_examples]['name'],
+            placeholder="e.g., Bug Report or Feqture Request or Question",
+            on_change = None)
         
-        in_name = st.text_input("Name Metadata: ", placeholder="e.g., Bug Report or Feqture Request or Question", on_change=None)
-        in_about = st.text_input("About Metadata: ", placeholder="e.g., File a bug report", on_change=None)
+        in_about = st.text_input(
+            label = "About Metadata: ",
+            value = examples[in_examples]['about'],
+            placeholder="e.g., File a bug report",
+            on_change=None)
+
+        # Title
+        if examples[in_examples]['title'] == '<|EMPTY|>':
+            empty_title_value_default = True
+        else:
+            empty_title_value_default = False
+        in_empty_title = st.checkbox(label ='without title', value = empty_title_value_default)
+
+        if in_empty_title == False:
+            # check if the example title is actually not empty
+            title_value_default = examples[in_examples]['title'] if examples[in_examples]['title'] != '<|EMPTY|>' else ""
+            in_title = st.text_input(
+            label = "Title Metadata: ",
+            value = title_value_default,
+            placeholder="e.g., [Bug]: ",
+            on_change=None)
+        else:
+            in_title = '<|EMPTY|>'
 
-        empty_title = st.checkbox('without title')
-        if empty_title == False:
-            in_title = st.text_input("Title Metadata: ", placeholder="e.g., [Bug]: ", on_change=None)
+        # Labels
+        if examples[in_examples]['labels'] == '<|EMPTY|>':
+            empty_labels_value_default = True
         else:
-            in_title = '<|EMPTY|>'    
-        
-        empty_labels = st.checkbox('without labels')
-        if empty_labels == False:
-            in_labels = st.text_input("Labels Metadata: ", placeholder="e.g., feature, enhancement", on_change=None)
+            empty_labels_value_default = False
+        in_empty_labels = st.checkbox(label ='without labels', value = empty_labels_value_default)
+
+        if in_empty_labels == False:
+            # check if the example labels is actually not empty
+            labels_value_default = examples[in_examples]['labels'] if examples[in_examples]['labels'] != '<|EMPTY|>' else ""
+            in_labels = st.text_input(
+            label = "Labels Metadata: ",
+            value = labels_value_default,
+            placeholder="e.g., feature, enhancement",
+            on_change=None)
         else:
             in_labels = '<|EMPTY|>'
 
-        empty_assignees = st.checkbox('without Assignees')
-        if empty_assignees == False:
-            in_assignees = st.text_input("Assignees Metadata: ", placeholder="e.g., USER_1, USER_2", on_change=None)
+        # Assignees
+        if examples[in_examples]['assignees'] == '<|EMPTY|>':
+            empty_assignees_value_default = True
+        else:
+            empty_assignees_value_default = False
+        in_empty_assignees = st.checkbox(label ='without assignees', value = empty_assignees_value_default)
+
+        if in_empty_assignees == False:
+            # check if the example assignees is actually not empty
+            assignees_value_default = examples[in_examples]['assignees'] if examples[in_examples]['assignees'] != '<|EMPTY|>' else ""
+            in_assignees = st.text_input(
+            label = "Assignees Metadata: ",
+            value = assignees_value_default,
+            placeholder="e.g., feature, enhancement",
+            on_change=None)
         else:
             in_assignees = '<|EMPTY|>'
-            
+
+        # headline type
+        if examples[in_examples]['headlines_type'] == '<|EMPTY|>':
+            headlines_type_value_default = 3
+        elif examples[in_examples]['headlines_type'] == '':
+            headlines_type_value_default = 2
+        elif examples[in_examples]['headlines_type'] == '**Emphasis**':
+            headlines_type_value_default = 1
+        else:
+            headlines_type_value_default = 0
+
         # if no headlines is selected, force the headlines to be empty as well.
         in_headline_type = st.selectbox(
-        'How would you like to be your Headlines?',
-        ('**Emphasis**', '# Heading', 'No headlines'))
+        label = 'How would you like to be your Headlines?',
+        options = ('# Heading', '**Emphasis**', 'Either', 'No headlines'),
+        index = headlines_type_value_default)
+
+        if in_headline_type == 'Either':
+            in_headline_type = '<|MASK|>'
+
+        if in_headline_type == 'No headlines':
+            in_headline_type = '<|EMPTY|>'
+            in_headlines = '<|EMPTY|>'
+
 
         if in_headline_type!='No headlines':
-            in_headlines = st.text_area("Headlines: ", placeholder="Enter each headline in one line. e.g.,\nWelcome\nConcise Description\nAdditional Info", on_change=None, height=200)
+            
+            headlines_value_default = examples[in_examples]['headlines'] if examples[in_examples]['headlines'] != '<|EMPTY|>' else ""
+
+            in_headlines = st.text_area(
+                label = "Headlines: ",
+                value = headlines_value_default,
+                placeholder="Enter each headline in one line. e.g.,\nWelcome\nConcise Description\nAdditional Info",
+                on_change=None,
+                height=200)
 
             if not in_headlines:
                 in_headlines = '<|MASK|>'
@@ -132,19 +224,16 @@ with st.sidebar:
                 in_headlines = in_headlines.split('\n')
                 in_headlines = [element.strip() for element in in_headlines]
 
-        else:
-            in_headline_type = '<|EMPTY|>'
-            in_headlines = '<|EMPTY|>'
 
-        # df = pd.DataFrame(
-        # [{"headline": "Welcome"},{"headline": "Concise Description"}, {"headline": "Additional Info"}])
-        # in_headlines = st.experimental_data_editor(df, num_rows="dynamic")
+        # summary
+        summary_value_default = examples[in_examples]['summary'] if examples[in_examples]['summary'] != '<|EMPTY|>' else ""
+        in_summary = st.text_area(
+            label = "Summary: ",
+            value = summary_value_default,
+            placeholder="This Github Issue Template is ...",
+            on_change=None,
+            height=200)
 
-        in_summary = st.text_area("Summary: ", placeholder="This Github Issue Template is ...", on_change=None, height=200)
-
-        in_examples = st.selectbox(
-        'Select one of the following examples or implement yours:',
-        ('Example 1', 'Example 2', 'Example 3', 'Example 4'))
 
     with st.expander("🎛 Model Configs", False):
         max_length_in = st.slider("max_length", 30, 512, 300)
@@ -154,51 +243,16 @@ with st.sidebar:
 
     
 
-tab1, tab2 = st.tabs(["Design GitHub Issue Template", "Manual Prompt"])
-
-with tab1:
-
-    clicked_2 = st.button("Submit", key='pr-sub')
-    if clicked_2:
-        prompt = create_instruction(in_name, in_about, in_title, in_labels, in_assignees, in_headline_type, in_headlines, in_summary)
-        st.code(prompt, language="python")
-        with st.spinner("Please Wait..."):
-            res = compute(prompt, top_p = top_p_in, top_k=top_k_in, do_sample=True, max_length=max_length_in, min_length=min_length_in)
-            st.code(res, language="python")
-
-    # template_prompt = "name:"
-    # filled_prompt = "name:"
-
-    # clicked = st.button("Submit", key='design')
-
-    # with st.spinner("Please Wait..."):
-
-    #     if filled_prompt!=template_prompt:
-    #         res = compute(prompt, top_p=0.92, top_k=0, do_sample=True, max_length=300, min_length=0)
-    #         st.code(res, language="python")
-    # prompt = create_instruction(in_name, in_about, in_title, in_labels, in_assignees, in_headline_type, in_headlines, in_summary)
+prompt = create_instruction(in_name, in_about, in_title, in_labels, in_assignees, in_headline_type, in_headlines, in_summary)
 
-    # clicked = st.button("Submit", key='custom-prompt')
+prompt_manual = st.text_area(
+        label = "Enter your prompt here.",
+        value = prompt,
+        placeholder=None)
 
-    # with st.spinner("Please Wait..."):
-
-    #     res = compute(prompt, top_p = top_p_in, top_k=top_k_in, do_sample=True, max_length=max_length_in, min_length=min_length_in)
-    #     st.code(res, language="python")
-
-
-
-with tab2:
-
-    st.markdown('This part is only based on the prompt you provide here and not the issue template inputs.')
-
-    prompt = st.text_area("Prompt: ", placeholder="Enter your prompt.", on_change=None, height=200)
-
-    clicked = st.button("Submit", key='prompt')
+clicked = st.button("Submit")
 
+if clicked:
     with st.spinner("Please Wait..."):
-
-        if prompt:
-            res = compute(prompt, top_p=0.92, top_k=0, do_sample=True, max_length=300, min_length=0)
-            st.code(res, language="python")
-
-
+        res = compute(prompt_manual, top_p = top_p_in, top_k=top_k_in, do_sample=True, max_length=max_length_in, min_length=min_length_in)
+        st.code(res, language="python")

assets/examples.json

@@ -0,0 +1,54 @@
+{
+    "bug report": {
+        "name": "Bug report",
+        "about": "Ask a question about the <|Repo_Name|>",
+        "title": "bug",
+        "labels": "",
+        "assignees": "<|EMPTY|>",
+        "headlines_type": "**Emphasis**",
+        "headlines": "['Description', 'Steps to reproduce', 'Expected behavior', 'Screenshot or video', 'Environment', 'version']",
+        "summary": "<|EMPTY|>"
+
+    },
+    "feature request": {
+        "name": "feature",
+        "about": "Suggest a feature for the <|Repo_Name|>",
+        "title": "<|EMPTY|>",
+        "labels": "<|EMPTY|>",
+        "assignees": "<|EMPTY|>",
+        "headlines_type": "# Heading",
+        "headlines": "",
+        "summary": "This Github issue template is designed to help users suggest features for the <|Repo_Name|>. Before submitting an issue, users should ensure they have checked the documentation and forums, verified that the feature has not already been proposed, and selected the correct repository for multi-repository projects. The feature description should be clear and concise, outlining the desired outcome and any related problems. Alternative solutions and screenshots may also be included."
+
+    },
+    "question": {
+        "name": "Question",
+        "about": "Ask a question about the <|Repo_Name|>",
+        "title": "<|EMPTY|>",
+        "labels": "kind/question",
+        "assignees": "<|EMPTY|>",
+        "headlines_type": "",
+        "headlines": "",
+        "summary": "This Github issue template is designed to encourage users to first check the documentation, search for answers online, and ask their colleagues for help before opening a new issue. If the user has already done these steps, they are encouraged to provide their question in the issue. The template includes three questions for the user to answer before opening the issue."   
+    },
+    "documentation": {
+        "name": "documentation",
+        "about": "",
+        "title": "[Doc]",
+        "labels": "docs",
+        "assignees": "<|EMPTY|>",
+        "headlines_type": "# Heading",
+        "headlines": "['Documentation Scope', 'Describe the Change', 'Screenshots', 'Additional context']",
+        "summary": "This Github issue template is for adding or updating documentation. The documentation can be for various things, such as the homepage, getting started, or user manuals."   
+    },
+    "no example": {
+        "name": "",
+        "about": "",
+        "title": "",
+        "labels": "",
+        "assignees": "",
+        "headlines_type": "# Heading",
+        "headlines": "",
+        "summary": ""   
+    }
+}