Duplicate from NealCaren/DYF

.gitattributes

@@ -0,0 +1,36 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tar filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text
+dyf_w_embeddings.json filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,14 @@
+---
+title: DYF
+emoji: ⚡
+colorFrom: purple
+colorTo: gray
+sdk: gradio
+sdk_version: 3.39.0
+app_file: app.py
+pinned: false
+license: cc-by-nc-4.0
+duplicated_from: NealCaren/DYF
+---
+
+Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference

app.py

@@ -0,0 +1,206 @@
+import pandas as pd
+from glob import glob
+from scipy import spatial 
+from collections import defaultdict
+
+import tiktoken
+import openai
+import gradio as gr
+from tenacity import retry, stop_after_attempt, wait_random_exponential
+
+
+
+#df = pd.read_json('https://www.dropbox.com/scl/fi/uh964d1k6woc9wo3l2slc/dyf_w_embeddings.json?rlkey=j23j5338n4e88kvvsmj7s7aff&dl=1')
+df = pd.read_json('dyf_w_embeddings.json')
+
+
+GPT_MODEL = 'gpt-3.5-turbo'
+EMBEDDING_MODEL = "text-embedding-ada-002"
+
+# search function
+def strings_ranked_by_relatedness(
+    query: str,
+    df: pd.DataFrame,
+    relatedness_fn=lambda x, y: 1 - spatial.distance.cosine(x, y),
+    top_n: int = 25
+) -> tuple[list[str], list[float]]:
+    """Returns a list of strings and relatednesses, sorted from most related to least."""
+    query_embedding_response = openai.Embedding.create(
+        model=EMBEDDING_MODEL,
+        input=query,
+    )
+    query_embedding = query_embedding_response["data"][0]["embedding"]
+    strings_and_relatednesses = [
+        (row["citation"]+':\n'+row["text"]+'\nINDEX:'+str(i), relatedness_fn(query_embedding, row["embedding"]))
+        for i, row in df.iterrows()
+    ]
+    strings_and_relatednesses.sort(key=lambda x: x[1], reverse=True)
+    strings, relatednesses = zip(*strings_and_relatednesses)
+    return strings[:top_n], relatednesses[:top_n]
+
+def num_tokens(text: str, model: str = GPT_MODEL) -> int:
+    """Return the number of tokens in a string."""
+    encoding = tiktoken.encoding_for_model(model)
+    return len(encoding.encode(text))
+
+def double_check(question, passage):
+    
+    message = f'Possibly related text:{passage}\n\nSearch query: {question}'
+    messages = [
+        {"role": "system", "content": "Is the following text topically related to the search query. Answer with just Yes or No."},
+        {"role": "user", "content": message},
+    ]
+    response = openai.ChatCompletion.create(
+        model='gpt-3.5-turbo',
+        messages=messages,
+        temperature=0
+    )
+    response_message = response["choices"][0]["message"]["content"]
+    if 'yes' in response_message.lower():
+        return True
+    return False
+    return response_message
+
+def extract_numbers_after_index(text):
+    numbers = []
+    lines = text.split("\n")
+
+    for line in lines:
+        if "INDEX:" in line:
+            index = line.split("INDEX:")[1].strip()
+            try:
+                number = int(index)
+                numbers.append(number)
+            except ValueError:
+                pass
+
+    return numbers
+
+
+def query_message(
+    query: str,
+    df: pd.DataFrame,
+    model: str,
+    token_budget: int
+) -> str:
+    """Return a message for GPT, with relevant source texts pulled from a dataframe."""
+    strings, relatednesses = strings_ranked_by_relatedness(query, df)
+    introduction = 'Use the below articles written by W.E.B. Du Bois subsequent question. Write your response in the form of an four paragraph essay for a college class. If the answer cannot be found in the articles, write "I could not find an answer. Be sure to put direct quotations in quotation marks. Use in APA-Style text references where approriate.'
+    message = introduction
+    article_cites = defaultdict(int)
+    
+    for counter, string in enumerate(strings):
+        article_cite = string.splitlines()[0]
+        next_article = f'\n\nDu Bois article:\n"""\n{string}\n"""'
+        if (
+            num_tokens(message + next_article + query, model=model)
+            > token_budget
+        ):
+            break
+        else:
+            if double_check(query, string) == True and article_cites[article_cite] <= 2:
+                message += next_article
+                article_cites[article_cite] += 1
+    print(article_cites)     
+    return message + query
+
+def remove_lines_with_index(input_string):
+    lines = input_string.strip().split('\n')
+    cleaned_lines = [line for line in lines if "INDEX:" not in line]
+    cleaned_string = "\n".join(cleaned_lines)
+    return cleaned_string
+
+def ask(
+    query: str,
+
+) -> str:
+    """Answers a query using GPT and a dataframe of relevant texts and embeddings."""
+    
+    model = GPT_MODEL
+    token_budget = 4096 - 600
+
+        
+    message = query_message(query, df, model=model, token_budget=token_budget)
+    
+    # Add references
+    cite_rows = extract_numbers_after_index(message)
+    used_df = df[df.index.isin(cite_rows)].copy()
+    citations = list(set(used_df['citation'].values))
+    if len(citations) == 0:
+        return "No relevant articles found. Sorry. Please try a different question."
+    
+    resources = '**Resources**\n* ' + '\n* '.join(sorted(citations))
+    # clean up to remove index
+    message = remove_lines_with_index(message)
+    
+    
+    messages = [
+        {"role": "system", "content": "You answer questions based on the writings of W.E.B. Du Bois. All the provided texts are written by Du Bois."},
+        {"role": "user", "content": message},
+    ]
+    response = openai.ChatCompletion.create(
+        model=model,
+        messages=messages,
+        temperature=0
+    )
+    response_message = response["choices"][0]["message"]["content"]
+    
+
+    
+    answer = f'{resources}\n\n**Summary**\n\n{response_message}'
+    return answer
+
+
+
+intro_text = '''
+# W.E.B. Du Bois in the Crisis
+
+This search engine find the most relevant articles from [Dare You Fight](https://www.dareyoufight.org), an online repository of W.E.B. Du Bois's writings in The Crisis, the official journal of the NAACP, which Du Bois founded and edited between 1911 and 1934. In addition to locating the most relevant articles, it also produces a short essay in response to your question. 
+
+**Notes:** 
+* Avoid using "Du Bois" in the question, as this is information is passed along behind the scenes. 
+* Searches can take 20 to 40 seconds.
+* You may need a follow up question if your original question is only a word or two.
+* The model usually looks at five or fewer relevant articles, so if you response requires more, consider refining and splitting up your question. 
+
+**Caveats:** Like all apps that employ large language models, this one has the possiblitiy for bias and confabulation. Please refer to the original articles. 
+
+'''
+
+outro_text = '''
+**Behind the Scenes**
+
+This app uses sentence embeddings and a large language model to craft the response. Behind the scenes, it involves the following steps:
+
+1. Each article from Dare You Fight (or segment of the article if it's long) is converted into a fixed-length vector representation using OpenAI's text-embedding-ada-002 model. These representations are stored in a dataframe.
+2. The user's query is embedded using the same text-embedding-ada-002 model to convert it into a fixed-length vector representation.
+3. To find the most relevant articles to the query, cosine similarity is calculated between the query vector and all the article vectors. The articles with the highest cosine similarity are retrieved as the top matches.
+4. The text of each of the possibly related articles (based on Step 3) is passed to OpenAI's ChatGPT 3.5 model, along with a question asking whether the text is relevant to the search query. Only texts coded as relevant are used in subsequent steps.
+5. All of the relevant texts (from Step 4), along with the original search query, are passed to OpenAI's ChatGPT 3.5 model with specific instructions to answer the query in the form of a college essay using only the supplied texts.
+'''
+
+
+
+block = gr.Blocks(theme = 'bethecloud/storj_theme')
+
+with block:
+    gr.Markdown(intro_text)
+        
+    # Define the input and output blocks
+    input_block = gr.Textbox(label='Question')
+    research_btn = gr.Button(value="Ask the archive")
+    output_block = gr.Markdown(label="Response")
+    research_btn.click(ask, inputs=input_block, outputs=output_block)
+    gr.Examples(["What is the relationship between social, political and economic equality?", 
+                 "What is Pan-Africanism?",
+                 "Did Du Bois support American involvement in WWI?",
+                 "What are the most effective tactics or methods for racial equality?",
+                 "Why was the NAACP founded and what was it's original goals?"], inputs=[input_block])
+    gr.Markdown(outro_text)
+
+# Launch the interface
+block.launch()
+
+
+
+

dyf_w_embeddings.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:19e11cdb2873c39c9065973a98f3ca436f507935074c8c1af1d6ef82481ebe36
+size 23555987

requirements.txt

@@ -0,0 +1,4 @@
+scipy
+tiktoken
+openai
+tenacity