├── .streamlit └── config.toml ├── LICENSE ├── README.md ├── app.py ├── functionforDownloadButtons.py ├── logo.png └── requirements.txt /.streamlit/config.toml: -------------------------------------------------------------------------------- 1 | [theme] 2 | primaryColor = "#00B4B3" 3 | backgroundColor = "#FFFFFF" 4 | secondaryBackgroundColor = "#F0F2F6" 5 | textColor = "#262730" 6 | font = "sans serif" 7 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Open in Streamlit](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://share.streamlit.io/streamlit/example-app-bert-keyword-extractor/main/app.py) 2 | 3 | 4 | # Bert Keyword Extractor 5 | 6 | - The BERT Keyword Extractor app is an easy-to-use interface built in 7 | Streamlit for the amazing KeyBERT library from Maarten Grootendorst! 8 | - It uses a minimal keyword extraction technique that leverages 9 | multiple NLP embeddings and relies on Transformers 🤗 to create 10 | keywords/keyphrases that are most similar to a document. 11 | 12 | ![image](https://user-images.githubusercontent.com/27242399/140746511-1205f24a-869f-4b24-9ed7-9153cfeef8e3.png) 13 | -------------------------------------------------------------------------------- /app.py: -------------------------------------------------------------------------------- 1 | import streamlit as st 2 | import numpy as np 3 | from pandas import DataFrame 4 | from keybert import KeyBERT 5 | # For Flair (Keybert) 6 | from flair.embeddings import TransformerDocumentEmbeddings 7 | import seaborn as sns 8 | # For download buttons 9 | from functionforDownloadButtons import download_button 10 | import os 11 | import json 12 | 13 | st.set_page_config( 14 | page_title="BERT Keyword Extractor", 15 | page_icon="🎈", 16 | ) 17 | 18 | 19 | def _max_width_(): 20 | max_width_str = f"max-width: 1400px;" 21 | st.markdown( 22 | f""" 23 | 28 | """, 29 | unsafe_allow_html=True, 30 | ) 31 | 32 | 33 | _max_width_() 34 | 35 | c30, c31, c32 = st.columns([2.5, 1, 3]) 36 | 37 | with c30: 38 | # st.image("logo.png", width=400) 39 | st.title("🔑 BERT Keyword Extractor") 40 | st.header("") 41 | 42 | 43 | 44 | with st.expander("ℹ️ - About this app", expanded=True): 45 | 46 | st.write( 47 | """ 48 | - The *BERT Keyword Extractor* app is an easy-to-use interface built in Streamlit for the amazing [KeyBERT](https://github.com/MaartenGr/KeyBERT) library from Maarten Grootendorst! 49 | - It uses a minimal keyword extraction technique that leverages multiple NLP embeddings and relies on [Transformers] (https://huggingface.co/transformers/) 🤗 to create keywords/keyphrases that are most similar to a document. 50 | """ 51 | ) 52 | 53 | st.markdown("") 54 | 55 | st.markdown("") 56 | st.markdown("## **📌 Paste document **") 57 | with st.form(key="my_form"): 58 | 59 | 60 | ce, c1, ce, c2, c3 = st.columns([0.07, 1, 0.07, 5, 0.07]) 61 | with c1: 62 | ModelType = st.radio( 63 | "Choose your model", 64 | ["DistilBERT (Default)", "Flair"], 65 | help="At present, you can choose between 2 models (Flair or DistilBERT) to embed your text. More to come!", 66 | ) 67 | 68 | if ModelType == "Default (DistilBERT)": 69 | # kw_model = KeyBERT(model=roberta) 70 | 71 | @st.cache(allow_output_mutation=True) 72 | def load_model(): 73 | return KeyBERT(model=roberta) 74 | 75 | kw_model = load_model() 76 | 77 | else: 78 | @st.cache(allow_output_mutation=True) 79 | def load_model(): 80 | return KeyBERT("distilbert-base-nli-mean-tokens") 81 | 82 | kw_model = load_model() 83 | 84 | top_N = st.slider( 85 | "# of results", 86 | min_value=1, 87 | max_value=30, 88 | value=10, 89 | help="You can choose the number of keywords/keyphrases to display. Between 1 and 30, default number is 10.", 90 | ) 91 | min_Ngrams = st.number_input( 92 | "Minimum Ngram", 93 | min_value=1, 94 | max_value=4, 95 | help="""The minimum value for the ngram range. 96 | 97 | *Keyphrase_ngram_range* sets the length of the resulting keywords/keyphrases. 98 | 99 | To extract keyphrases, simply set *keyphrase_ngram_range* to (1, 2) or higher depending on the number of words you would like in the resulting keyphrases.""", 100 | # help="Minimum value for the keyphrase_ngram_range. keyphrase_ngram_range sets the length of the resulting keywords/keyphrases. To extract keyphrases, simply set keyphrase_ngram_range to (1, # 2) or higher depending on the number of words you would like in the resulting keyphrases.", 101 | ) 102 | 103 | max_Ngrams = st.number_input( 104 | "Maximum Ngram", 105 | value=2, 106 | min_value=1, 107 | max_value=4, 108 | help="""The maximum value for the keyphrase_ngram_range. 109 | 110 | *Keyphrase_ngram_range* sets the length of the resulting keywords/keyphrases. 111 | 112 | To extract keyphrases, simply set *keyphrase_ngram_range* to (1, 2) or higher depending on the number of words you would like in the resulting keyphrases.""", 113 | ) 114 | 115 | StopWordsCheckbox = st.checkbox( 116 | "Remove stop words", 117 | help="Tick this box to remove stop words from the document (currently English only)", 118 | ) 119 | 120 | use_MMR = st.checkbox( 121 | "Use MMR", 122 | value=True, 123 | help="You can use Maximal Margin Relevance (MMR) to diversify the results. It creates keywords/keyphrases based on cosine similarity. Try high/low 'Diversity' settings below for interesting variations.", 124 | ) 125 | 126 | Diversity = st.slider( 127 | "Keyword diversity (MMR only)", 128 | value=0.5, 129 | min_value=0.0, 130 | max_value=1.0, 131 | step=0.1, 132 | help="""The higher the setting, the more diverse the keywords. 133 | 134 | Note that the *Keyword diversity* slider only works if the *MMR* checkbox is ticked. 135 | 136 | """, 137 | ) 138 | 139 | with c2: 140 | doc = st.text_area( 141 | "Paste your text below (max 500 words)", 142 | height=510, 143 | ) 144 | 145 | MAX_WORDS = 500 146 | import re 147 | res = len(re.findall(r"\w+", doc)) 148 | if res > MAX_WORDS: 149 | st.warning( 150 | "⚠️ Your text contains " 151 | + str(res) 152 | + " words." 153 | + " Only the first 500 words will be reviewed. Stay tuned as increased allowance is coming! 😊" 154 | ) 155 | 156 | doc = doc[:MAX_WORDS] 157 | 158 | submit_button = st.form_submit_button(label="✨ Get me the data!") 159 | 160 | if use_MMR: 161 | mmr = True 162 | else: 163 | mmr = False 164 | 165 | if StopWordsCheckbox: 166 | StopWords = "english" 167 | else: 168 | StopWords = None 169 | 170 | if not submit_button: 171 | st.stop() 172 | 173 | if min_Ngrams > max_Ngrams: 174 | st.warning("min_Ngrams can't be greater than max_Ngrams") 175 | st.stop() 176 | 177 | keywords = kw_model.extract_keywords( 178 | doc, 179 | keyphrase_ngram_range=(min_Ngrams, max_Ngrams), 180 | use_mmr=mmr, 181 | stop_words=StopWords, 182 | top_n=top_N, 183 | diversity=Diversity, 184 | ) 185 | 186 | st.markdown("## **🎈 Check & download results **") 187 | 188 | st.header("") 189 | 190 | cs, c1, c2, c3, cLast = st.columns([2, 1.5, 1.5, 1.5, 2]) 191 | 192 | with c1: 193 | CSVButton2 = download_button(keywords, "Data.csv", "📥 Download (.csv)") 194 | with c2: 195 | CSVButton2 = download_button(keywords, "Data.txt", "📥 Download (.txt)") 196 | with c3: 197 | CSVButton2 = download_button(keywords, "Data.json", "📥 Download (.json)") 198 | 199 | st.header("") 200 | 201 | df = ( 202 | DataFrame(keywords, columns=["Keyword/Keyphrase", "Relevancy"]) 203 | .sort_values(by="Relevancy", ascending=False) 204 | .reset_index(drop=True) 205 | ) 206 | 207 | df.index += 1 208 | 209 | # Add styling 210 | cmGreen = sns.light_palette("green", as_cmap=True) 211 | cmRed = sns.light_palette("red", as_cmap=True) 212 | df = df.style.background_gradient( 213 | cmap=cmGreen, 214 | subset=[ 215 | "Relevancy", 216 | ], 217 | ) 218 | 219 | c1, c2, c3 = st.columns([1, 3, 1]) 220 | 221 | format_dictionary = { 222 | "Relevancy": "{:.1%}", 223 | } 224 | 225 | df = df.format(format_dictionary) 226 | 227 | with c2: 228 | st.table(df) 229 | -------------------------------------------------------------------------------- /functionforDownloadButtons.py: -------------------------------------------------------------------------------- 1 | import streamlit as st 2 | import pickle 3 | import pandas as pd 4 | import json 5 | import base64 6 | import uuid 7 | import re 8 | 9 | import importlib.util 10 | 11 | 12 | def import_from_file(module_name: str, filepath: str): 13 | """ 14 | Imports a module from file. 15 | 16 | Args: 17 | module_name (str): Assigned to the module's __name__ parameter (does not 18 | influence how the module is named outside of this function) 19 | filepath (str): Path to the .py file 20 | 21 | Returns: 22 | The module 23 | """ 24 | spec = importlib.util.spec_from_file_location(module_name, filepath) 25 | module = importlib.util.module_from_spec(spec) 26 | spec.loader.exec_module(module) 27 | return module 28 | 29 | 30 | def notebook_header(text): 31 | """ 32 | Insert section header into a jinja file, formatted as notebook cell. 33 | 34 | Leave 2 blank lines before the header. 35 | """ 36 | return f"""# # {text} 37 | 38 | """ 39 | 40 | 41 | def code_header(text): 42 | """ 43 | Insert section header into a jinja file, formatted as Python comment. 44 | 45 | Leave 2 blank lines before the header. 46 | """ 47 | seperator_len = (75 - len(text)) / 2 48 | seperator_len_left = math.floor(seperator_len) 49 | seperator_len_right = math.ceil(seperator_len) 50 | return f"# {'-' * seperator_len_left} {text} {'-' * seperator_len_right}" 51 | 52 | 53 | def to_notebook(code): 54 | """Converts Python code to Jupyter notebook format.""" 55 | notebook = jupytext.reads(code, fmt="py") 56 | return jupytext.writes(notebook, fmt="ipynb") 57 | 58 | 59 | def open_link(url, new_tab=True): 60 | """Dirty hack to open a new web page with a streamlit button.""" 61 | # From: https://discuss.streamlit.io/t/how-to-link-a-button-to-a-webpage/1661/3 62 | if new_tab: 63 | js = f"window.open('{url}')" # New tab or window 64 | else: 65 | js = f"window.location.href = '{url}'" # Current tab 66 | html = ''.format(js) 67 | div = Div(text=html) 68 | st.bokeh_chart(div) 69 | 70 | 71 | def download_button(object_to_download, download_filename, button_text): 72 | """ 73 | Generates a link to download the given object_to_download. 74 | 75 | From: https://discuss.streamlit.io/t/a-download-button-with-custom-css/4220 76 | 77 | Params: 78 | ------ 79 | object_to_download: The object to be downloaded. 80 | download_filename (str): filename and extension of file. e.g. mydata.csv, 81 | some_txt_output.txt download_link_text (str): Text to display for download 82 | link. 83 | 84 | button_text (str): Text to display on download button (e.g. 'click here to download file') 85 | pickle_it (bool): If True, pickle file. 86 | 87 | Returns: 88 | ------- 89 | (str): the anchor tag to download object_to_download 90 | 91 | Examples: 92 | -------- 93 | download_link(your_df, 'YOUR_DF.csv', 'Click to download data!') 94 | download_link(your_str, 'YOUR_STRING.txt', 'Click to download text!') 95 | 96 | """ 97 | # if pickle_it: 98 | # try: 99 | # object_to_download = pickle.dumps(object_to_download) 100 | # except pickle.PicklingError as e: 101 | # st.write(e) 102 | # return None 103 | 104 | # if: 105 | if isinstance(object_to_download, bytes): 106 | pass 107 | 108 | elif isinstance(object_to_download, pd.DataFrame): 109 | object_to_download = object_to_download.to_csv(index=False) 110 | # Try JSON encode for everything else 111 | else: 112 | object_to_download = json.dumps(object_to_download) 113 | 114 | try: 115 | # some strings <-> bytes conversions necessary here 116 | b64 = base64.b64encode(object_to_download.encode()).decode() 117 | except AttributeError as e: 118 | b64 = base64.b64encode(object_to_download).decode() 119 | 120 | button_uuid = str(uuid.uuid4()).replace("-", "") 121 | button_id = re.sub("\d+", "", button_uuid) 122 | 123 | custom_css = f""" 124 | """ 150 | 151 | dl_link = ( 152 | custom_css 153 | + f'{button_text}

' 154 | ) 155 | # dl_link = f'

' 156 | 157 | st.markdown(dl_link, unsafe_allow_html=True) 158 | 159 | 160 | # def download_link( 161 | # content, label="Download", filename="file.txt", mimetype="text/plain" 162 | # ): 163 | # """Create a HTML link to download a string as a file.""" 164 | # # From: https://discuss.streamlit.io/t/how-to-download-file-in-streamlit/1806/9 165 | # b64 = base64.b64encode( 166 | # content.encode() 167 | # ).decode() # some strings <-> bytes conversions necessary here 168 | # href = ( 169 | # f'{label}' 170 | # ) 171 | # return href 172 | -------------------------------------------------------------------------------- /logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/streamlit/example-app-bert-keyword-extractor/b5dc67b63a2b981421f198e6d3747cc18b17edae/logo.png -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | seaborn 2 | matplotlib 3 | streamlit == 0.87 4 | pandas == 1.2.4 5 | keybert 6 | flair 7 | click<8 8 | --------------------------------------------------------------------------------