app complete

.gitignore

@@ -0,0 +1,174 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

README.md

@@ -1,13 +1,74 @@
----
-title: ClimateChatbotUganda
-emoji: 📉
-colorFrom: red
-colorTo: red
-sdk: streamlit
-sdk_version: 1.44.1
-app_file: app.py
-pinned: false
-short_description: AI-powered chatbot for climate awareness in Uganda
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Climate Change Awareness Chatbot
+
+## Overview
+The app is now live! Try playing with it here: [QuantumCoders-TheSDGGuardiansAI](https://quantumcoders-thesdgguardiansai.streamlit.app/).
+
+The Climate Change Awareness Chatbot is an AI-powered chatbot designed to educate users in Uganda about climate change, sustainability, and eco-friendly practices. It provides factual answers to questions on climate change impacts, sustainable farming, afforestation, renewable energy, and more.
+
+## Features
+
+- **Interactive Chat**: Users can ask climate-related questions and receive AI-generated responses.
+- **Localized Context**: Focuses on climate issues specific to Uganda.
+- **Chat History**: Keeps track of past conversations in the sidebar.
+- **Avatars**: Displays user and chatbot messages with appropriate icons.
+- **Sample Questions**: Provides predefined questions to guide users.
+- **Clear Chat History**: Users can reset conversations from the sidebar.
+
+
+## Technologies Used
+
+- **Python**
+- **Streamlit** (for UI and chat interaction)
+- **Hugging Face Transformers** (for NLP model)
+- **ClimateBERT** (for climate-related question answering)
+
+## Installation
+
+Clone the repository:
+
+```sh
+git clone https://github.com/codingxperience/QuantumCoders-TheSDGGuardiansAI.git
+cd QuantumCoders-TheSDGGuardiansAI
+```
+
+Install dependencies:
+
+```sh
+pip install -r requirements.txt
+```
+
+Run the application:
+
+```sh
+streamlit run app.py
+```
+
+## Usage
+
+1. Type a message in the input box and press **Enter**.
+2. View responses in the chat window.
+3. Click on **Sample Questions** to see common queries.
+4. Use the **Clear Chat History** button to reset the conversation.
+
+## Future Enhancements
+
+- **Expanding coverage to include other African regions** in future versions.
+
+- **Retraining the model with Ugandan-specific climate data** to improve relevance and accuracy for local environmental challenges.
+
+- **Integration with real-time climate data APIs**.
+- **Visualization of climate trends and statistics**.
+- **Multilingual support in English, Luganda, and Swahili**.
+- **Offline and USSD capabilities for users in low or no-internet areas**.
+- **Support for voice, image, and video interactions**.
+- **Integration with social media platforms**.
+
+## Contributing
+
+Pull requests are welcome! If you'd like to contribute, please fork the repository and create a new branch for your changes.
+
+## License
+
+This project is for educational purposes and is open for improvement and collaboration.
+
+Developed as part of the **QuantumCoders-TheSDGGuardiansAI - 2024** initiative for a greener Uganda.

app.py

@@ -0,0 +1,305 @@
+# Author: Fred Okorio
+# Date: 2024-01-01
+# Description: A Streamlit app for a Climate Change Awareness Chatbot using the ClimateGPT-7B model.
+
+
+# Have to SWITCH to this more expressive model before the deadline.
+
+
+# # necessary libraries
+# import streamlit as st
+# import accelerate
+# from transformers import AutoTokenizer, AutoModelForCausalLM
+# import torch
+
+# # page configuration
+# st.set_page_config(page_title="Climate Change Awareness Chatbot", layout="wide")
+
+# # ClimateGPT-7B model and tokenizer
+# @st.cache_resource
+# def load_climategpt():
+#     tokenizer = AutoTokenizer.from_pretrained("eci-io/climategpt-7b")
+#     model = AutoModelForCausalLM.from_pretrained("eci-io/climategpt-7b", device_map="auto")
+#     return tokenizer, model
+
+# tokenizer, model = load_climategpt()
+
+# # generate responses
+# def generate_response(user_input):
+#     prompt = f"""
+# <|im_start|>system
+# You are ClimateGPT, a large language model trained to provide information on climate change.<|im_end|>
+# <|im_start|>user
+# {user_input}<|im_end|>
+# <|im_start|>assistant
+# """
+#     inputs = tokenizer(prompt, return_tensors="pt").to(model.device)
+#     outputs = model.generate(**inputs, max_new_tokens=200)
+#     response = tokenizer.decode(outputs[0], skip_special_tokens=True)
+#     return response.split("<|im_end|>")[-1].strip()
+
+# # initialize session state for chat history
+# if "history" not in st.session_state:
+#     st.session_state.history = []
+
+# # sidebar for chat history
+# with st.sidebar:
+#     st.title("Chat History")
+#     for idx, (question, answer) in enumerate(st.session_state.history[::-1]):
+#         with st.expander(f"💬 {question}"):
+#             st.write(f"**Chatbot:** {answer}")
+
+#     st.markdown("---")
+#     st.info("🌱 *Ask me anything about climate change, sustainability, or eco-friendly living.*")
+
+# # main chat interface
+# st.title("Climate Change Awareness Chatbot")
+# st.subheader("Get answers, tips, and climate change facts for Uganda & East Africa")
+
+# # Display chat history
+# for question, answer in st.session_state.history:
+#     st.markdown(f"**You:** {question}")
+#     st.success(f"**Chatbot:** {answer}")
+#     st.markdown("---")
+
+# # User input
+# user_input = st.text_input("💬 Type your message and press Enter", key="text_input")
+
+# if user_input:
+#     response = generate_response(user_input)
+
+#     # Append conversation to history
+#     st.session_state.history.append((user_input, response))
+
+#     # Clear input field after processing
+#     st.session_state.text_input = ""
+
+#     # Rerun the app to display the updated chat history
+#     st.experimental_rerun()
+
+# # Clear chat history button
+# if st.button("Clear Chat History"):
+#     st.session_state.history = []
+#     st.experimental_rerun()
+
+# # Footer
+# st.markdown("""
+# ---
+# *Educational Purpose Only* | 🌱 **SDG Guardians AI - 2024** | *For a greener East Africa*
+# """)
+
+# import streamlit as st
+# from transformers import pipeline, AutoTokenizer, AutoModelForQuestionAnswering
+
+# # page configuration
+# st.set_page_config(page_title="Climate Chatbot - Uganda & East Africa", layout="wide")
+
+# # model loading...
+# @st.cache_resource
+# def load_climate_bert():
+#     tokenizer = AutoTokenizer.from_pretrained("NinaErlacher/ClimateBERTqa")
+#     model = AutoModelForQuestionAnswering.from_pretrained("NinaErlacher/ClimateBERTqa")
+#     qa_pipeline = pipeline("question-answering", model=model, tokenizer=tokenizer)
+#     return qa_pipeline
+
+# qa_pipeline = load_climate_bert()
+
+# def generate_response(user_question, context):
+#     result = qa_pipeline(question=user_question, context=context)
+#     return result['answer']
+
+# # Initialize session state variables
+# if "history" not in st.session_state:
+#     st.session_state.history = []
+
+# # Sidebar for chat history
+# with st.sidebar:
+#     st.title("Chat History")
+#     for idx, (question, answer) in enumerate(st.session_state.history[::-1]):
+#         with st.expander(f"💬 {question}"):
+#             st.write(f"**Chatbot:** {answer}")
+
+#     st.markdown("---")
+#     st.info("🌱 *Ask me anything about climate change, sustainability, or eco-friendly living.*")
+
+# # main chat UI
+# st.title("Climate Change Awareness Chatbot")
+# st.subheader("Get answers, tips, and climate change facts for Uganda & East Africa")
+
+# # chat display
+# chat_container = st.container()
+# with chat_container:
+#     for question, answer in st.session_state.history:
+#         st.markdown(f"**You:** {question}")
+#         st.success(f"**Chatbot:** {answer}")
+#         st.markdown("---")
+
+# User input
+# user_input = st.text_input("💬 Type your message and press Enter", key="text_input")
+
+# if user_input:  
+#     context = """
+#     Climate change is affecting Uganda and East Africa in various ways, including unpredictable rainfall patterns, 
+#     increased temperatures, and prolonged droughts. Sustainable farming practices, afforestation, and renewable 
+#     energy adoption are key solutions to mitigate these effects.
+#     """  # Placeholder context
+
+#     response = generate_response(user_input, context)
+
+#     # append conversation to history
+#    /' ' st.session_state.history.append((user_input, response))
+
+#     # Clear stored input after processing
+#     st.session_state.pop("text_input", None)  
+#     st.rerun()
+
+# # Clear chat history button
+# if st.button("Clear Chat History"):
+#     st.session_state.history = []
+#     st.rerun()
+
+# # footer
+# st.markdown("""
+# ---
+#  *Educational Purpose Only* | 🌱 **SDG Guardians AI - 2024** |  *For a greener East Africa*
+# """)
+
+import streamlit as st
+from transformers import pipeline, AutoTokenizer, AutoModelForQuestionAnswering
+
+# Page configuration
+st.set_page_config(page_title="Climate Chatbot - Uganda", layout="wide")
+
+# Custom CSS for shadow effect
+st.markdown(
+    """
+    <style>
+    .stChatInput {
+        box-shadow: 0px 10px 20px rgba(0, 0, 0, 0.4);  /* Strong shadow */
+        border-radius: 10px;
+        padding: 12px;
+        background: white;
+    }
+    .stChatInput::before {
+        content: "";
+        position: absolute;
+        width: 100%;
+        height: 15px;
+        left: 0;
+        background: linear-gradient(to top, rgba(0, 0, 0, 0.3), rgba(0, 0, 0, 0)); /* Fading effect */
+    }
+    </style>
+    """,
+    unsafe_allow_html=True
+)
+
+# Load model
+@st.cache_resource
+def load_climate_bert():
+    tokenizer = AutoTokenizer.from_pretrained("NinaErlacher/ClimateBERTqa")
+    model = AutoModelForQuestionAnswering.from_pretrained("NinaErlacher/ClimateBERTqa")
+    return pipeline("question-answering", model=model, tokenizer=tokenizer)
+
+qa_pipeline = load_climate_bert()
+
+# Function to check if question is climate-related
+def is_climate_related(question):
+    climate_keywords = ["climate", "global warming", "deforestation", "carbon", "sustainability", 
+                        "renewable", "pollution", "green energy", "climate action", "afforestation"]
+    return any(keyword in question.lower() for keyword in climate_keywords)
+
+# Function to check if Uganda is mentioned
+def is_uganda_related(question):
+    return "uganda" in question.lower() or "east africa" in question.lower()
+
+# Function to generate response
+def generate_response(user_question, context):
+    if not is_climate_related(user_question):
+        return "I'm here to discuss climate change. Try asking about Uganda's climate, sustainability, or environmental issues."
+    if not is_uganda_related(user_question):
+        return "This chatbot focuses on climate change in Uganda. Try asking about Uganda's environmental challenges."
+    
+    result = qa_pipeline(question=user_question, context=context)
+    return result['answer']
+
+# Session state for chat history
+if "history" not in st.session_state:
+    st.session_state.history = []
+
+# Sidebar - Chat History & Clear Button
+with st.sidebar:
+    st.title("Chat History")
+    for idx, (question, answer) in enumerate(st.session_state.history[::-1]):
+        with st.expander(f"💬 {question}"):
+            st.write(f"**Chatbot:** {answer}")
+    st.markdown("---")
+    if st.button("🗑️ Clear Chat History"):
+        st.session_state.history = []
+        st.rerun()
+    st.info("🌱 *Ask about climate change in Uganda.*")
+
+# Main UI
+st.title("Climate Change Chatbot")
+st.subheader("Explore climate action and sustainability in Uganda")
+
+# Sample questions section
+with st.expander("Need ideas? (Click to expand)"):
+    st.markdown("""
+    - **How is Uganda affected by climate change?**
+    - **What are sustainable farming methods?**
+    - **How can I reduce my energy use?**
+    - **What are the risks of deforestation?**
+    - **Why is tree planting important?**
+    - **How can youth take action?**
+    """)
+
+# Chat container with avatars
+chat_container = st.container()
+with chat_container:
+    for question, answer in st.session_state.history:
+        with st.chat_message("user"):
+            st.write(question)
+        with st.chat_message("assistant"):
+            st.write(answer)
+
+# User input field with shadow effect
+user_input = st.chat_input("Ask about climate change in Uganda...")
+if user_input:
+    context = """
+    Climate change is affecting Uganda and East Africa in various ways, including unpredictable rainfall, 
+    rising temperatures, and prolonged droughts. Sustainable farming, afforestation, and renewable energy 
+    adoption are key solutions to mitigate these effects.
+    """  # Placeholder context
+    
+    response = generate_response(user_input, context)
+    st.session_state.history.append((user_input, response))
+    st.rerun()
+
+
+# seems to be overcrowding the page, so we can remove it for now.
+
+# # footer fixed at the bottom
+# st.markdown(
+#     """
+#     <style>
+#     .footer {
+#         position: fixed;
+#         bottom: 0;
+#         left: 100px;
+#         font-size: 14px;
+#         font-weight: 900;
+#         width: 100%;
+#         background-color: white;
+#         text-align: center;
+#         padding: 10px;
+#         box-shadow: 0px -2px 5px rgba(0, 0, 0, 0.1);
+#         z-index: 999;
+#     }
+#     </style>
+#     <div class="footer">
+#     ---  
+#     *Educational Purpose Only* | 🌱 **SDG Guardians AI - 2024** | *For a greener East Africa*
+#     </div>
+#     """,
+#     unsafe_allow_html=True
+# )