Upload 9 files

.gitattributes

@@ -33,3 +33,4 @@ saved_model/**/* 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
+ARIAL.TTF filter=lfs diff=lfs merge=lfs -text

ARIAL.TTF

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

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Candid
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,13 +1,13 @@
 ---
-title: Nonprofit Letters Of Intent
-emoji: 🔥
-colorFrom: pink
-colorTo: pink
+title: Nonprofit Letters of Intent
+short_description: Writing assistant for nonprofit letters of intent
+emoji: 📝💡
+colorFrom: yellow
+colorTo: red
 sdk: gradio
-sdk_version: 4.41.0
+sdk_version: 4.31.5
 app_file: app.py
-pinned: false
+pinned: true
 license: mit
 ---
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference

app.py

@@ -583,9 +583,12 @@ def build_feedback(components: LoggedComponents) -> gr.Blocks:
 
 def build_demo():
     logger, drafter = build_drafter()
+    # compliancy_check = build_compliancy_check()
     feedback = build_feedback(logger)
 
     return gr.TabbedInterface(
+        # interface_list=[drafter, compliancy_check, feedback],
+        # tab_names=["LOI writer", "Compliancy Check", "Feedback"],
         interface_list=[drafter, feedback],
         tab_names=["LOI writer", "Feedback"],
         title="Candid's letter of intent (LOI) writer",
@@ -599,6 +602,7 @@ if __name__ == '__main__':
         show_api=False,
         auth=[
             (os.getenv("APP_USERNAME"), os.getenv("APP_PASSWORD")),
+            # can add more username / password pairs
         ],
         auth_message="Login to Candid's letter of intent demo"
     )

constants.py

@@ -0,0 +1,102 @@
+# Dictionary of categories and their corresponding links
+CATEGORIES = {
+    "AFFORDABLE HOUSING AND HOMELESSNESS": """
+- National Low Income Housing Coalition: [Visit Site](https://nlihc.org)
+- National Alliance to End Homelessness: [Visit Site](https://endhomelessness.org)
+- National Coalition for the Homeless: [Visit Site](https://nationalhomeless.org)
+- Department of Housing and Urban Development: [Visit Site](https://portal.hud.gov/hudportal/HUD)
+""",
+    "AGING": """
+- Administration on Aging/Data Resources: [Visit Site](https://aoa.acl.gov/Aging_Statistics/index.asp)
+""",
+    "ARTS": """
+- The Research Center for Arts and Culture: [Visit Site](https://artsandcultureresearch.org)
+- Americans for the Arts: [Visit Site](https://americansforthearts.org)
+""",
+    "CHILDREN AND POVERTY": """
+- National Center for Children in Poverty: [Visit Site](https://nccp.org)
+- Children’s Defense Fund: [Visit Site](https://childrensdefense.org)
+- Save the Children: [Visit Site](https://savethechildren.org)
+""",
+    "EDUCATION": """
+- National Center for Education Statistics: [Visit Site](https://nces.ed.gov)
+""",
+    "ENERGY ASSISTANCE": """
+- Low Income Energy Assistance Program: [Visit Site](https://acf.hhs.gov/programs/ocs/liheap)
+""",
+    "ENVIRONMENT": """
+- Stanford Geospacial Center (GIS data online): [Visit Site](https://library.stanford.edu/research/stanford-geospatial-center/data)
+- Environmental Protection Agency: [Visit Site](https://epa.gov)
+""",
+    "HEALTH": """
+- Center for Disease Control: [Visit Site](https://cdc.gov)
+- State Public Health Data/Trust for America’s Health: [Visit Site](https://healthyamericans.org/states)
+""",
+    "HUNGER": """
+- Crop Walk: [Visit Site](https://crophungerwalk.org)
+- Bread for the World: [Visit Site](https://bread.org)
+""",
+    "INTERNATIONAL": """
+- United Nations Statistics Division: [Visit Site](https://unstats.un.org/unsd/databases.htm)
+""",
+    "LIVING WAGE": """
+- The Living Wage Resource Center: [Visit Site](https://livingwagecampaign.org)
+- Economic Policy Institute: [Visit Site](https://epi.org)
+- Bureau of Labor Statistics: [Visit Site](https://bls.gov)
+""",
+    "POVERTY": """
+- U.S. Department of Health and Human Services Poverty Guidelines: [Visit Site](https://aspe.hhs.gov/poverty)
+- Center of Urban Poverty: [Visit Site](https://povertycenter.case.edu)
+- National Poverty Center: [Visit Site](https://npc.umich.edu)
+""",
+    "UNITED STATES": """
+- IssueLab: [Visit Site](https://issuelab.org)
+- US Census: [Visit Site](https://census.gov)
+- FedStats: [Visit Site](https://fedstats.sites.usa.gov)
+- The Urban Institute: [Visit Site](https://urban.org)
+""",
+    "YOUTH": """
+- Youth Risk Behavioral Survey: [Visit Site](https://cdc.gov/Features/YRBS)
+"""
+}
+
+# Editorial ai css
+CSS = """
+.custom-textarea {
+    width: 100%;
+    height: 300px;
+    border: 1px solid #ccc;
+    padding: 10px;
+    font-size: 16px;
+    line-height: 1.5;
+}
+
+mark {
+    background-color: #ffcccc;  /* Faded red */
+}
+"""
+
+
+# Editorial ai js
+JS = """
+document.addEventListener('DOMContentLoaded', function() {
+    // Listen for changes in the textarea
+    let textarea = document.getElementById('highlighted_textarea');
+    textarea.addEventListener('input', function() {
+        // Reapply the highlighting (simple implementation)
+        let content = textarea.innerText;
+        let highlightedContent = content;
+        for (let highlightText of window.highlightTexts) {
+            highlightedContent = highlightedContent.replace(
+                new RegExp(escapeRegExp(highlightText), 'g'),
+                `<mark>${highlightText}</mark>`
+            );
+        }
+        textarea.innerHTML = highlightedContent;
+    });
+});
+
+function escapeRegExp(string) {
+    return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
+}
+"""

editor.py

@@ -0,0 +1,98 @@
+from typing import List, Tuple
+import logging
+
+import gradio as gr
+
+from .services import identify_vague_statements
+
+
+def create_editable_section(label, js_script, submit_fn, textbox):
+    with gr.Accordion(f"Edit {label}", open=False) as acc:
+        output_text = gr.HTML(label="Highlighted Text", elem_id=f"highlighted_textarea_{label}", value=textbox)
+        output_text_suggestion = gr.Textbox(label="Suggestions", lines=5, interactive=True)
+        with gr.Row():
+            submit_button = gr.Button("Run Editorial AI", size="small")
+            accept_button = gr.Button("Apply Changes", size="small")
+
+        edit_pairs = gr.State([])
+
+        def submit_callback(default_text):
+            result = submit_fn(default_text)
+            pairs = result["pairs"]
+            edit_pairs.value = pairs
+            return result["html"], result["suggestions"]
+
+        def update_change(changes, original):
+            for old_text, new_text in changes:
+                modified = original.replace(old_text, new_text)
+            return modified
+
+        # pylint: disable=no-member
+        submit_button.click(
+            # fn=submit_fn,
+            fn=submit_callback,
+            inputs=textbox,
+            outputs=[output_text, output_text_suggestion]
+        )
+
+        # pylint: disable=no-member
+        accept_button.click(
+            fn=update_change,
+            inputs=[edit_pairs, textbox],
+            outputs=textbox
+        )
+
+        # Add custom JavaScript to make the output area editable
+        gr.HTML(f"<script>{js_script}</script>")
+    return acc
+
+
+def highlight_text(input_section: str) -> Tuple[str, List[str], List[str], List[str]]:
+    try:
+        # Escape special characters for HTML
+        input_section = input_section.replace("&", "&amp;").replace("<", "&lt;").replace(">", "&gt;")
+        vague_statements, alternative_texts, reasons = identify_vague_statements(input_section)
+
+        highlighted_text = input_section
+        for vague_statement in vague_statements:
+            vague_statement = vague_statement.replace("&", "&amp;").replace("<", "&lt;").replace(">", "&gt;")
+            highlighted_text = highlighted_text.replace(vague_statement, f'<mark>{vague_statement}</mark>')
+
+        logging.info("Success: Highlight text")
+        return highlighted_text, vague_statements, alternative_texts, reasons
+
+    except Exception as e:
+        logging.error("Error: %s", e)
+        # return input_section, [], [], []
+        raise gr.Error("Error in Extracting vague statements..")
+
+
+def update_highlighted_text(default_text: str):
+    gr.Info("Running Editorial AI..")
+    # progress = gr.Progress()
+    # progress(0, desc="Starting...")
+    highlighted_text, vague_statements, alternative_texts, reasons = highlight_text(default_text)
+    suggestions = ""
+    pairs = []
+    # for vague, alternative, reason in progress.tqdm(zip(vague_statements, alternative_texts, reasons)):
+    for vague, alternative, reason in zip(vague_statements, alternative_texts, reasons):
+        pairs.append((vague, alternative))
+        suggestions += f"Vague Statement: {vague}\nReason: {reason}\nAlternative Text: {alternative}\n\n"
+
+    html = f"""
+        <div id="highlighted_textarea" class="custom-textarea" contenteditable="true">
+            {highlighted_text}
+        </div>
+        <script>
+            window.highlightTexts = [{', '.join([f'`{sentence.replace("&", "&amp;").replace("<", "&lt;").replace(">", "&gt;")}`' for sentence in vague_statements])}];
+        </script>
+    """
+
+    result = {
+        "html": html,
+        "suggestions": suggestions,
+        "pairs": pairs
+    }
+
+    logging.info("Highlighted the text successfully..")
+    return result

requirements.txt

@@ -0,0 +1,7 @@
+backoff
+fpdf2
+gradio
+langchain
+pydantic
+python-docx
+requests

services.py

@@ -0,0 +1,221 @@
+from typing import List, Dict, Tuple, Union, Optional, Any
+import os
+
+import gradio as gr
+
+import requests
+import backoff
+
+
+class OrganizationNotFound(Exception):
+    "No organization(s) found"
+
+
+@backoff.on_exception(
+    backoff.expo,
+    (requests.exceptions.Timeout, requests.exceptions.ConnectionError),
+    max_tries=5
+)
+def _get_json(route: str, **request_kwargs) -> Dict[str, Any] | str:
+    r = requests.get(
+        url=f"{os.getenv('LOI_API_URL')}/{route}",
+        params=request_kwargs,
+        headers={"x-api-key": os.getenv("LOI_API_KEY")},
+        timeout=30
+    )
+
+    r.raise_for_status()
+    return r.json().get("response")
+
+
+@backoff.on_exception(
+    backoff.expo,
+    (requests.exceptions.Timeout, requests.exceptions.ConnectionError),
+    max_tries=5
+)
+def _post_json(route: str, *, payload: Dict[str, Any]) -> Dict[str, Any] | str | int:
+    r = requests.post(
+        url=f"{os.getenv('LOI_API_URL')}/{route}",
+        json=payload,
+        headers={"x-api-key": os.getenv("LOI_API_KEY")},
+        timeout=30
+    )
+
+    r.raise_for_status()
+    return r.json().get("response")
+
+
+def organization_pair_autofill(
+    recipient_name: str,
+    recipient_ein: str,
+    funder_name: str,
+    funder_ein: str
+):
+    recip_match = _get_json("/organization/search", name=recipient_name, ein=recipient_ein)
+    if len(recip_match or []) == 0:
+        # raise OrganizationNotFound()
+        raise gr.Error("No matching recipient could be found")
+    gr.Info(f"{recipient_name} found, auto-filling fields...")
+
+    funder_match = _get_json("/organization/search", name=funder_name, ein=funder_ein)
+    if len(funder_match or []) == 0:
+        # raise OrganizationNotFound()
+        raise gr.Error("No matching funder could be found")
+    gr.Info(f"{funder_name} found, auto-filling fields...")
+
+    data = _get_json(
+        "/organization/autofill",
+        recipient_candid_entity_id=recip_match[0]["candid_entity_id"],
+        funder_candid_entity_id=funder_match[0]["candid_entity_id"],
+    )
+
+    return (
+        data.get("recipient_data", {}).get("projects_text"),
+        data.get("recipient_data", {}).get("capacity_text"),
+        data.get("recipient_data", {}).get("contact_text"),
+        data.get("recipient_data", {}).get("data_text"),  # accomplishments
+        data.get("recipient_data", {}).get("mission_statement_text"),
+        data.get("funder_data", {}).get("mission_statement_text"),
+        data.get("funding_history_text"),
+        data.get("recipient_data", {}).get("org_data"),
+        recip_match[0]["candid_entity_id"],
+        data.get("funder_data", {}).get("org_data"),
+        funder_match[0]["candid_entity_id"],
+    )
+
+
+def cost_estimator(
+    recipient_candid_entity_id: Union[int, str],
+    recipient_data: Dict[str, Any],
+    funder_data: Dict[str, Any],
+    program_desc: Optional[str] = None
+) -> str:
+    estimate: str = _post_json(
+        "/budget",
+        payload={
+            "recipient_candid_entity_id": recipient_candid_entity_id,
+            "program_description": program_desc,
+            "recipient_data": recipient_data,
+            "funder_data": funder_data,
+        }
+    )
+    return estimate
+
+
+def identify_vague_statements(text: str) -> Tuple[List[str], List[str], List[str]]:
+    data = _get_json("/editorialai/vaguestatement", input_section=text)
+    return (
+        data.get("vague_statements") or [],
+        data.get("alternative_texts") or [],
+        data.get("reasons") or [],
+        # data.get("alternative_texts") or [],
+    )
+
+
+def help_mission_statement(recipient_name: str, recipient_mission_info: str):
+    return _get_json("/writerhelper/missionstatement", info=recipient_mission_info, org_name=recipient_name)
+
+
+def draft_letter(
+    recipient_name: str, funder_name: str, projects: str, amount: str,
+    recipient_mission_statement: str = "", funder_mission_statement: str = "",
+    project_name: str = "", project_purpose: str = "",
+    prior_contact: str = "", connection: str = "",
+    capacity: str = "", path_to_solution: str = "", recent_accomplishments: str = "",
+    recipient_history: str = "", mutual_history: str = "",
+    geo_pop_targets: str = "", project_data_stats: str = "",
+    desired_objectives: str = "", major_activities: str = "", key_staff: str = "", standout_features: str = "",
+    success_metric: str = "",
+    other_funding_sources: str = "",
+    contact_information: str = ""
+):
+    gr.Info("Writing the letter, please scroll to the top of the page.")
+    opening: str = _get_json(
+        "/writer/opening",
+        funder_name=funder_name,
+        recipient_name=recipient_name,
+        project_name=project_name,
+        project_purpose=project_purpose,
+        amount=amount,
+        prior_contact=prior_contact,
+        connection=connection
+    )
+
+    recipient_description: str = _get_json(
+        "/writer/org",
+        opening=opening,
+        recipient_mission_statement=recipient_mission_statement,
+        capacity=capacity,
+        history=recipient_history,
+        path=path_to_solution,
+        accomplishment=recent_accomplishments
+    )
+
+    need_statement: str  = _get_json(
+        "/writer/need",
+        recipient_desc=recipient_description,
+        target=geo_pop_targets,
+        data=project_data_stats,
+        funder_mission_statement=funder_mission_statement
+    )
+
+    project_description: str = _get_json(
+        "/writer/project",
+        need=need_statement,
+        projects=projects,
+        desired_objectives=desired_objectives,
+        major_activities=major_activities,
+        key_staff=key_staff,
+        stand_out=standout_features,
+        success=success_metric
+    )
+
+    funding_request: str = _get_json(
+        "/writer/fund",
+        project_desc=project_description,
+        amount=amount,
+        funding_history=mutual_history,
+        other_funding=other_funding_sources
+    )
+
+    conclusion: str = _get_json(
+        "/writer/conclusion",
+        funding_request=funding_request,
+        project_desc=project_description,
+        follow_up=contact_information
+    )
+
+    return (
+        opening,
+        recipient_description,
+        need_statement,
+        project_description,
+        funding_request,
+        conclusion
+    )
+
+
+def send_feedback(
+    context: Dict[str, Any],
+    letter: Dict[str, Any],
+    relevance: int,
+    coherence: int,
+    fluency: int,
+    overall_quality: int,
+    comments: Optional[str] = None,
+    email: Optional[str] = None
+) -> int:
+    count = _post_json(
+        "/feedback",
+        payload={
+            "context": context,
+            "letter": letter,
+            "relevance": relevance,
+            "coherence": coherence,
+            "fluency": fluency,
+            "overall_quality": overall_quality,
+            "comments": comments,
+            "email": email
+        }
+    )
+    return count