README.md

---
title: PNA Assistant
emoji: 👨🏾‍⚕️
colorFrom: indigo
colorTo: purple
sdk: gradio
sdk_version: 5.12.0
app_file: app.py
pinned: false
---

<p align="center">
  <img src="https://em-content.zobj.net/source/apple/391/woman-health-worker-medium-skin-tone_1f469-1f3fd-200d-2695-fe0f.png" width="80" alt="PNA Logo">
</p>

<h1 align="center">Professional Nurse Advocate Assistant</h1>

<p align="center">
  <strong>AI-Powered Support for the A-EQUIP Model & Restorative Supervision</strong>
</p>

<p align="center">
  <a href="https://huggingface.co/spaces/NurseCitizenDeveloper/PNA-Assistant">
    <img src="https://img.shields.io/badge/Status-Research_Use_Only-orange?style=for-the-badge" alt="Research Use Only">
  </a>
  <a href="https://huggingface.co/spaces/NurseCitizenDeveloper/PNA-Assistant">
    <img src="https://img.shields.io/badge/🤗%20Live%20Demo-Hugging%20Face-yellow" alt="Hugging Face Space">
  </a>
  <a href="https://huggingface.co/google/gemma-2-2b-it">
    <img src="https://img.shields.io/badge/Model-Gemma%202%202B%20IT-blue" alt="Model">
  </a>
  <img src="https://img.shields.io/badge/License-Apache%202.0-green" alt="License">
  <img src="https://img.shields.io/badge/Python-3.10+-blue" alt="Python">
</p>

<p align="center">
  👨🏾‍⚕️ 👩🏽‍⚕️ 👨🏿‍⚕️ 👩🏻‍⚕️ 👩‍⚕️
</p>

---

## 📋 Table of Contents

- [About](#-about)
- [Key Features](#-key-features)
- [The A-EQUIP Model](#-the-a-equip-model)
- [Technology Stack](#-technology-stack)
- [Repository Structure](#-repository-structure)
- [Roadmap](#-roadmap)
- [Local Development](#-local-development)
- [Contributing](#-contributing)
- [Important Disclaimers](#-important-disclaimers)
- [Citation](#-citation)
- [Acknowledgements](#-acknowledgements)

---

## 🏥 About

The **Professional Nurse Advocate (PNA) Assistant** is an AI-powered educational tool designed to support nursing professionals in understanding and applying the **A-EQUIP model** (Advocating and Educating for Quality Improvement).

This tool focuses on:
- **Restorative Clinical Supervision** - Supporting staff wellbeing
- **Person-Centred Communication** - Compassionate, reflective dialogue
- **Quality Improvement** - Guiding continuous professional development

---

## 🚀 Key Features

| Feature | Description |
|---------|-------------|
| **RAG-Powered Knowledge** | Retrieval-Augmented Generation using the official A-EQUIP Model Guide |
| **Foundation Model** | Powered by Gemma 2 2B IT, instruction-tuned for clear, safe, and helpful dialogue |
| **Premium UI** | Modern, accessible interface with NHS-inspired design |
| **Diversity-First** | Inclusive design with diverse healthcare worker representation |

---

## 📚 The A-EQUIP Model

The A-EQUIP model provides a framework for Professional Nurse Advocates with four key functions:

1. **Normative** - Monitoring quality and standards
2. **Formative** - Education and skill development
3. **Restorative** - Clinical supervision and staff wellbeing (primary focus)
4. **Personal Action for Quality Improvement** - Driving positive change

---

## 🧠 Technology Stack

- **Base Model**: [google/gemma-2-2b-it](https://huggingface.co/google/gemma-2-2b-it)
- **Architecture**: RAG (Context-Aware) + Instruction Tuned LLM
- **Framework**: Gradio + Hugging Face Spaces (ZeroGPU)
- **Knowledge Base**: RAG with Sentence Transformers + FAISS

---

## � Repository Structure

```
├── app.py                 # Main application file (Gradio UI & Logic)
├── pna_client.py          # LLM Client handling generation
├── knowledge_base.py      # RAG implementation (FAISS + Embeddings)
├── requirements.txt       # Project dependencies
├── Professional...Guide.md# Source knowledge base document
└── README.md              # Documentation
```

---

## 🗺️ Roadmap

- [x] **Phase 1**: Initial Deployment with RAG & Fine-tuned Model
- [ ] **Phase 2**: TranslateGemma Live (Real-Time WebRTC Audio/Video Translation)
- [ ] **Phase 3**: Voice Integration for Spoken Restorative Supervision
- [ ] **Phase 4**: Integration with NHS e-Learning Platforms

---

## 🛠️ Local Development

```bash
# Clone the repository
git clone https://github.com/ClinyQAi/Professional-Nurse-Advocate-Assistant.git
cd Professional-Nurse-Advocate-Assistant

# Install dependencies
pip install -r requirements.txt

# Run locally
python app.py
```

---

## 🤝 Contributing

Contributions are always welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to get started.

---

## ⚠️ Important Disclaimers

> [!CAUTION]
> ### For Educational & Research Purposes Only
> This AI assistant is designed **exclusively for educational and research purposes**. It does NOT provide:
> - Clinical advice or diagnosis
> - Treatment recommendations
> - Mental health crisis support
> 
> **Important Note on AI Limitations:**
> While this assistant may provide general information about accessing services or resources, **we cannot guarantee the accuracy of this information**. AI models can "hallucinate" or provide outdated details. Always verify outputs with authoritative sources.

> [!WARNING]
> ### Not a Substitute for Professional Support
> - This tool is **not a replacement** for qualified Professional Nurse Advocates, clinical supervisors, or mental health professionals.
> - **If you or someone you know is experiencing a mental health crisis, please contact a qualified healthcare professional immediately or call your local emergency services.**

---

## 🎓 Citation

If you use this tool or model in your research, please cite:

```bibtex
@software{gombedza_pna_assistant_2024,
  author = {Gombedza, Lincoln},
  title = {The Professional Nurse Advocate AI: A specialized language model for supporting nursing workforce resilience research},
  year = {2024},
  publisher = {Hugging Face},
  url = {https://huggingface.co/spaces/NurseCitizenDeveloper/PNA-Assistant},
  version = {1.0.0}
}
```

## 📜 System Card & Methodology
For a detailed technical breakdown of the system architecture, RAG implementation, and ethical considerations, please see the [**System Card**](SYSTEM_CARD.md).

---

## 👤 Author

**Lincoln Gombedza**  
*Registered Learning Disability Nurse | Practice Educator | AI Researcher | Nurse Citizen Developer*

- 🐙 GitHub: [@NurseCitizenDeveloper](https://github.com/NurseCitizenDeveloper)
- 🤗 Hugging Face: [NurseCitizenDeveloper](https://huggingface.co/NurseCitizenDeveloper)
- 🏥 Organisation: [ClinyQAi](https://github.com/ClinyQAi)

---

## 🙏 Acknowledgements

This project builds upon the work of many individuals and organisations:

- **[Foundation of Nursing Studies (FONS)](https://www.fons.org/)** - For person-centred nursing principles
- **[NHS England](https://www.england.nhs.uk/)** - For the A-EQUIP Model and PNA Framework
- **[Google](https://ai.google.dev/gemma)** - For the Gemma 2 open model family
- **[Hugging Face](https://huggingface.co/)** - For hosting and ZeroGPU infrastructure

---

## 📄 License

This project is licensed under the **Apache License 2.0** - see the [LICENSE](LICENSE) file for details.

<p align="center">
  <sub>Made with ❤️ for the nursing profession</sub>
</p>