Spaces:
Sleeping
Sleeping
Emmanuel Chinonye Nnajiofor commited on
Commit Β·
2704487
1
Parent(s): 4c42be0
Develop Github Pull Request Template
Browse files- Added a PULL_REQUEST_TEMPLATE.md
- Minor adjustments to Makefile and README.md files
- .github/PULL_REQUEST_TEMPLATE.md +95 -0
- Makefile +1 -1
- README.md +18 -10
.github/PULL_REQUEST_TEMPLATE.md
ADDED
|
@@ -0,0 +1,95 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Pull Request Submission - Clinical Assistant
|
| 2 |
+
|
| 3 |
+
## Description
|
| 4 |
+
|
| 5 |
+
|
| 6 |
+
**Related Issue(s):**
|
| 7 |
+
|
| 8 |
+
|
| 9 |
+
## Type of Change
|
| 10 |
+
|
| 11 |
+
- [ ] Bug fix (non-breaking change that fixes an issue)
|
| 12 |
+
- [ ] New feature (non-breaking change that adds functionality)
|
| 13 |
+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
|
| 14 |
+
- [ ] Documentation update
|
| 15 |
+
- [ ] Refactoring (no functional changes)
|
| 16 |
+
- [ ] CI/CD pipeline improvement
|
| 17 |
+
|
| 18 |
+
## Technical Implementation Details
|
| 19 |
+
|
| 20 |
+
|
| 21 |
+
**Modified Components:**
|
| 22 |
+
|
| 23 |
+
- [ ] `app.py` (Gradio entry point)
|
| 24 |
+
- [ ] `chat.py`
|
| 25 |
+
- [ ] `main.py`
|
| 26 |
+
- [ ] `chatlib/` (Core logic)
|
| 27 |
+
- [ ] `assistant_node.py`
|
| 28 |
+
- [ ] `guidlines_rag_agent_li.py`
|
| 29 |
+
- [ ] `idsr_check.py`
|
| 30 |
+
- [ ] `logger.py`
|
| 31 |
+
- [ ] `patient_all_data.py`
|
| 32 |
+
- [ ] `patient_sql_agent.py`
|
| 33 |
+
- [ ] `phi_filter.py`
|
| 34 |
+
- [ ] `state_types.py`
|
| 35 |
+
- [ ] Requirements/dependencies
|
| 36 |
+
- [ ] Makefile
|
| 37 |
+
- [ ] Documentation
|
| 38 |
+
|
| 39 |
+
## Testing Performed
|
| 40 |
+
|
| 41 |
+
|
| 42 |
+
**Test Types Performed:**
|
| 43 |
+
- [ ] Unit tests (pytest)
|
| 44 |
+
- [ ] Integration tests
|
| 45 |
+
- [ ] Manual testing (Gradio UI)
|
| 46 |
+
- [ ] Security validation (PHI handling)
|
| 47 |
+
- [ ] Performance testing
|
| 48 |
+
|
| 49 |
+
**Test Results:**
|
| 50 |
+
|
| 51 |
+
|
| 52 |
+
## Quality Assurance Checklist
|
| 53 |
+
|
| 54 |
+
|
| 55 |
+
### Code Quality
|
| 56 |
+
- [ ] Code follows PEP8 style guidelines
|
| 57 |
+
- [ ] Docstrings added for new functions/classes
|
| 58 |
+
- [ ] Type hints added for function signatures
|
| 59 |
+
- [ ] No commented-out code
|
| 60 |
+
- [ ] No debugging statements (print/logging.debug) committed
|
| 61 |
+
|
| 62 |
+
### Validation
|
| 63 |
+
- [ ] All existing tests pass
|
| 64 |
+
- [ ] New tests added for changes
|
| 65 |
+
- [ ] Ran `make lint` with no warnings
|
| 66 |
+
- [ ] Ran `make format` before committing
|
| 67 |
+
- [ ] Verified Gradio UI functionality
|
| 68 |
+
- [ ] Confirmed SQL generation accuracy
|
| 69 |
+
|
| 70 |
+
### Documentation
|
| 71 |
+
- [ ] README.md updated if needed
|
| 72 |
+
- [ ] Docstrings added/modified
|
| 73 |
+
- [ ] Any new dependencies documented
|
| 74 |
+
- [ ] Special instructions added if needed
|
| 75 |
+
|
| 76 |
+
### Security
|
| 77 |
+
- [ ] Verified PHI filtering remains effective
|
| 78 |
+
- [ ] Confirmed no sensitive data exposure
|
| 79 |
+
- [ ] Checked for potential SQL injection vulnerabilities
|
| 80 |
+
|
| 81 |
+
## Deployment Notes
|
| 82 |
+
- [ ] Requirements.txt updated (if dependency changes)
|
| 83 |
+
- [ ] Migration steps required
|
| 84 |
+
- [ ] Environment variables changes
|
| 85 |
+
|
| 86 |
+
## Screenshots (if applicable)
|
| 87 |
+
|
| 88 |
+
|
| 89 |
+
**Before:**
|
| 90 |
+
|
| 91 |
+
|
| 92 |
+
**After:**
|
| 93 |
+
|
| 94 |
+
|
| 95 |
+
## Additional Context
|
Makefile
CHANGED
|
@@ -12,7 +12,7 @@ else
|
|
| 12 |
RM := rm -rf
|
| 13 |
endif
|
| 14 |
|
| 15 |
-
.PHONY: venv install
|
| 16 |
|
| 17 |
venv:
|
| 18 |
uv venv $(VENV)
|
|
|
|
| 12 |
RM := rm -rf
|
| 13 |
endif
|
| 14 |
|
| 15 |
+
.PHONY: venv install lint test format run clean
|
| 16 |
|
| 17 |
venv:
|
| 18 |
uv venv $(VENV)
|
README.md
CHANGED
|
@@ -30,6 +30,8 @@ A conversational assistant designed to help clinicians in Kenya access patient d
|
|
| 30 |
```
|
| 31 |
.
|
| 32 |
βββ app.py # Gradio web app entry point
|
|
|
|
|
|
|
| 33 |
βββ chatlib/ # Core logic, tools, and utilities
|
| 34 |
β βββ assistant_node.py
|
| 35 |
β βββ guidlines_rag_agent_li.py
|
|
@@ -39,9 +41,10 @@ A conversational assistant designed to help clinicians in Kenya access patient d
|
|
| 39 |
β βββ patient_sql_agent.py
|
| 40 |
β βββ phi_filter.py
|
| 41 |
β βββ state_types.py
|
| 42 |
-
βββ
|
| 43 |
-
βββ
|
| 44 |
-
|
|
|
|
| 45 |
```
|
| 46 |
|
| 47 |
---
|
|
@@ -91,13 +94,18 @@ A conversational assistant designed to help clinicians in Kenya access patient d
|
|
| 91 |
|
| 92 |
## Requirements
|
| 93 |
|
| 94 |
-
See `
|
| 95 |
-
-
|
| 96 |
-
-
|
| 97 |
-
-
|
| 98 |
-
-
|
| 99 |
-
-
|
| 100 |
-
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 101 |
|
| 102 |
---
|
| 103 |
|
|
|
|
| 30 |
```
|
| 31 |
.
|
| 32 |
βββ app.py # Gradio web app entry point
|
| 33 |
+
βββ chat.py
|
| 34 |
+
βββ main.py
|
| 35 |
βββ chatlib/ # Core logic, tools, and utilities
|
| 36 |
β βββ assistant_node.py
|
| 37 |
β βββ guidlines_rag_agent_li.py
|
|
|
|
| 41 |
β βββ patient_sql_agent.py
|
| 42 |
β βββ phi_filter.py
|
| 43 |
β βββ state_types.py
|
| 44 |
+
βββ Makefile # Common dev commands (lint, test, format, install, run, clean)
|
| 45 |
+
βββ pyproject.toml # Python dependencies
|
| 46 |
+
βββ README.md # Project documentation
|
| 47 |
+
βββ uv.lock
|
| 48 |
```
|
| 49 |
|
| 50 |
---
|
|
|
|
| 94 |
|
| 95 |
## Requirements
|
| 96 |
|
| 97 |
+
See `pyproject.toml` for the full list. Key dependencies:
|
| 98 |
+
- black>=25.1.0
|
| 99 |
+
- dateparser>=1.2.2
|
| 100 |
+
- faiss-cpu>=1.11.0
|
| 101 |
+
- gradio>=5.36.2
|
| 102 |
+
- langchain-community>=0.3.27
|
| 103 |
+
- langchain-openai>=0.3.27
|
| 104 |
+
- langgraph>=0.5.2
|
| 105 |
+
- llama-index>=0.12.48
|
| 106 |
+
- pandas>=2.3.1
|
| 107 |
+
- pylint>=3.3.7
|
| 108 |
+
- python-dotenv>=1.1.1
|
| 109 |
|
| 110 |
---
|
| 111 |
|