Nursing Citizen Development commited on
Commit
4a397fd
Β·
1 Parent(s): 197883c

Docs: Refine disclaimer with hallucination warning

Browse files
Files changed (1) hide show
  1. README.md +129 -18
README.md CHANGED
@@ -1,25 +1,136 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
- title: PNA Assistant
3
- emoji: πŸ‘¨πŸΎβ€βš•οΈ
4
- colorFrom: indigo
5
- colorTo: purple
6
- sdk: gradio
7
- sdk_version: 5.12.0
8
- app_file: app.py
9
- pinned: false
 
 
 
 
 
 
 
 
 
 
 
10
  ---
11
 
12
- # Professional Nurse Advocate (PNA) Assistant
13
 
14
- An AI-powered tutor designed to guide nursing professionals through the **A-EQUIP model** and **Restorative Supervision**.
15
 
16
- ## πŸš€ Deployment
17
- Automatically synced from GitHub via GitHub Actions.
 
 
18
 
19
- ## 🧠 Model Strategy
20
- - **Base Model**: `NurseCitizenDeveloper/relational-intelligence-medgemma-merged` (person-centred, fine-tuned on FONS principles)
21
- - **Knowledge Base**: RAG implementation using the official PNA A-EQUIP guide.
22
- - **Persona**: Strong PNA Tutor system prompting for restorative supervision focus.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
23
 
24
- ## βš–οΈ Disclaimer
25
- This tool is for educational and supportive purposes for Professional Nurse Advocates and nursing staff. It does not provide direct clinical advice.
 
 
1
+ <p align="center">
2
+ <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">
3
+ </p>
4
+
5
+ <h1 align="center">Professional Nurse Advocate Assistant</h1>
6
+
7
+ <p align="center">
8
+ <strong>AI-Powered Support for the A-EQUIP Model & Restorative Supervision</strong>
9
+ </p>
10
+
11
+ <p align="center">
12
+ <a href="https://huggingface.co/spaces/NurseCitizenDeveloper/PNA-Assistant">
13
+ <img src="https://img.shields.io/badge/πŸ€—%20Live%20Demo-Hugging%20Face-yellow" alt="Hugging Face Space">
14
+ </a>
15
+ <a href="https://huggingface.co/NurseCitizenDeveloper/relational-intelligence-medgemma-merged">
16
+ <img src="https://img.shields.io/badge/Model-MedGemma%20Fine--tuned-blue" alt="Model">
17
+ </a>
18
+ <img src="https://img.shields.io/badge/License-Apache%202.0-green" alt="License">
19
+ </p>
20
+
21
+ <p align="center">
22
+ πŸ‘¨πŸΎβ€βš•οΈ πŸ‘©πŸ½β€βš•οΈ πŸ‘¨πŸΏβ€βš•οΈ πŸ‘©πŸ»β€βš•οΈ πŸ‘©β€βš•οΈ
23
+ </p>
24
+
25
+ ---
26
+
27
+ ## πŸ₯ About
28
+
29
+ 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).
30
+
31
+ This tool focuses on:
32
+ - **Restorative Clinical Supervision** - Supporting staff wellbeing
33
+ - **Person-Centred Communication** - Compassionate, reflective dialogue
34
+ - **Quality Improvement** - Guiding continuous professional development
35
+
36
+ ---
37
+
38
+ ## ⚠️ Important Disclaimers
39
+
40
+ > [!CAUTION]
41
+ > ### For Educational & Research Purposes Only
42
+ > This AI assistant is designed **exclusively for educational and research purposes**. It does NOT provide:
43
+ > - Clinical advice or diagnosis
44
+ > - Treatment recommendations
45
+ > - Mental health crisis support
46
+ >
47
+ > **Important Note on AI Limitations:**
48
+ > 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.
49
+
50
+ > [!WARNING]
51
+ > ### Not a Substitute for Professional Support
52
+ > - This tool is **not a replacement** for qualified Professional Nurse Advocates, clinical supervisors, or mental health professionals.
53
+ > - **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.**
54
+
55
  ---
56
+
57
+ ## πŸš€ Features
58
+
59
+ | Feature | Description |
60
+ |---------|-------------|
61
+ | **RAG-Powered Knowledge** | Retrieval-Augmented Generation using the official A-EQUIP Model Guide |
62
+ | **Fine-Tuned Model** | Built on MedGemma, fine-tuned with person-centred nursing language (FONS principles) |
63
+ | **Premium UI** | Modern, accessible interface with NHS-inspired design |
64
+ | **Diversity-First** | Inclusive design with diverse healthcare worker representation |
65
+
66
+ ---
67
+
68
+ ## 🧠 Technology Stack
69
+
70
+ - **Base Model**: [google/medgemma-4b-it](https://huggingface.co/google/medgemma-4b-it)
71
+ - **Fine-Tuned Model**: [relational-intelligence-medgemma-merged](https://huggingface.co/NurseCitizenDeveloper/relational-intelligence-medgemma-merged)
72
+ - **Framework**: Gradio + Hugging Face Spaces (ZeroGPU)
73
+ - **Knowledge Base**: RAG with Sentence Transformers + FAISS
74
+
75
  ---
76
 
77
+ ## πŸ“š The A-EQUIP Model
78
 
79
+ The A-EQUIP model provides a framework for Professional Nurse Advocates with four key functions:
80
 
81
+ 1. **Normative** - Monitoring quality and standards
82
+ 2. **Formative** - Education and skill development
83
+ 3. **Restorative** - Clinical supervision and staff wellbeing (primary focus)
84
+ 4. **Personal Action for Quality Improvement** - Driving positive change
85
 
86
+ ---
87
+
88
+ ## πŸ› οΈ Local Development
89
+
90
+ ```bash
91
+ # Clone the repository
92
+ git clone https://github.com/ClinyQAi/Professional-Nurse-Advocate-Assistant.git
93
+ cd Professional-Nurse-Advocate-Assistant
94
+
95
+ # Install dependencies
96
+ pip install -r requirements.txt
97
+
98
+ # Run locally
99
+ python app.py
100
+ ```
101
+
102
+ ---
103
+
104
+ ## πŸ‘€ Author
105
+
106
+ **Tunde Olatunji**
107
+ *Registered Nurse | AI Researcher | Citizen Developer*
108
+
109
+ - πŸ™ GitHub: [@NurseCitizenDeveloper](https://github.com/NurseCitizenDeveloper)
110
+ - πŸ€— Hugging Face: [NurseCitizenDeveloper](https://huggingface.co/NurseCitizenDeveloper)
111
+ - πŸ₯ Organisation: [ClinyQAi](https://github.com/ClinyQAi)
112
+
113
+ ---
114
+
115
+ ## πŸ™ Acknowledgements
116
+
117
+ This project builds upon the work of many individuals and organisations:
118
+
119
+ - **[Foundation of Nursing Studies (FONS)](https://www.fons.org/)** - For person-centred nursing principles
120
+ - **[NHS England](https://www.england.nhs.uk/)** - For the A-EQUIP Model and PNA Framework
121
+ - **[Google Health AI](https://health.google/)** - For MedGemma foundation model
122
+ - **[AI Educator Toolkit](https://github.com/NurseCitizenDeveloper/AI-Educator-Toolkit)** - Author's educational AI resources
123
+ - **[Hugging Face](https://huggingface.co/)** - For hosting and ZeroGPU infrastructure
124
+ - **[Unsloth](https://github.com/unslothai/unsloth)** - For efficient fine-tuning tools
125
+
126
+ ---
127
+
128
+ ## πŸ“„ License
129
+
130
+ This project is licensed under the **Apache License 2.0** - see the [LICENSE](LICENSE) file for details.
131
+
132
+ ---
133
 
134
+ <p align="center">
135
+ <sub>Made with ❀️ for the nursing profession</sub>
136
+ </p>