working full app deployment backup

app.py

@@ -282,36 +282,74 @@ def redact_and_visualize(text: str, model_name: str):
 
 
 hint = """
-<p align="center">
-  <img src="https://github.com/MattStammers/Pteredactyl/blob/main/src/pteredactyl_webapp/assets/img/SETT_Logo.jpg" alt="SETT Logo" />
-</p>
+# Pteredactyl
 
-## Pteredactyl Gradio Webapp and API
+_Pteredactyl utilizes advanced natural language processing techniques to identify and anonymize clinical personally identifiable information (cPII) in clinical free text. It is built on top of Microsoft's [Presidio](https://microsoft.github.io/presidio/) and allows interchange of various transformer models from [Huggingface](https://huggingface.co/)_
 
-Clinical patient identifiable information (cPII) presents a significant challenge in natural language processing (NLP) that has yet to be fully resolved but significant progress is being made [1,2].
+## Features
 
-This is why we created [Pteredactyl](https://pypi.org/project/pteredactyl/) - a python module to help with redaction of clinical free text.
+- Anonymization of various entities such as names, locations, and phone numbers as per our [Documentation](https://mattstammers.github.io/Pteredactyl)
+- Support for processing both strings and pandas DataFrames
+- Text highlighting for easy identification of anonymized elements
+- Webapp with [Gradio](https://huggingface.co/spaces/MattStammers/pteredactyl_PII)
+- cPII benchmarking test: [Clinical_PII_Redaction_Test](https://huggingface.co/datasets/MattStammers/Clinical_PII_Redaction_Test)
+- Production API deployed using [Docker](https://www.docker.com/) and [Gradio](https://www.gradio.app/)
+- Hide in plain site replacement or masking option
+
+## Documentation
 
-## Tool Usage Instructions
+* Full documentation is available [here](https://mattstammers.github.io/Pteredactyl)
 
-When the input text is entered, the tool redacts the cPII from the entered text using NLP with labelled masking tokens and then assesses the models results. You can test the text against different models by selecting from the dropdown.
+## PyPi Installation
+
+Can be installed using pip from PyPi:
+
+```bash
+pip install pteredactyl
+```
+## Gradio Web App
 
-## Deployment Options
+This webapp is already available online as a gradio app on Huggingface: [Huggingface Gradio App](https://huggingface.co/spaces/MattStammers/pteredactyl_PII). It is also available as [source](https://github.com/SETT-Centre-Data-and-AI/PteRedactyl) or as a Docker Image: [Docker Image](https://registry.hub.docker.com/r/mattstammers/pteredactyl).
 
-This webapp is available online as a gradio app on Huggingface: [Huggingface Gradio App](https://huggingface.co/spaces/MattStammers/pteredactyl_PII). It is also available as [source](https://github.com/SETT-Centre-Data-and-AI/PteRedactyl) or as a Docker Image: [Docker Image](https://registry.hub.docker.com/r/mattstammers/pteredactyl). All are MIT licensed.
+## Docker Deployment
 
-Please note if deploying the docker image the port bindings are to 7860. The image can also be deployed from source using the following command:
+Please note if deploying the docker image the port bindings are to 7860. The image can be built and deployed from source using the following command:
 
 ```bat
 docker build -t pteredactyl:latest .
 docker run -d -p 7860:7860 --name pteredactyl-app pteredactyl:latest
 ```
 
+Or can be deployed directly from [Docker Hub](https://registry.hub.docker.com/r/mattstammers/pteredactyl)
+
+## Contributions
+Interested in contributing? Check out the contributing guidelines.
+
+* [Developer Guide](https://github.com/MattStammers/Pteredactyl/blob/main/CONTRIBUTING.md)
+
+Please note that this project follows the [Github code of conduct](https://docs.github.com/en/site-policy/github-terms/github-community-code-of-conduct). By contributing to this project, you agree to abide by its terms.
+
+## License
+Pteredactyl was created at University Hospital Southampton NHSFT by the Research Data Science Team. It is licensed under the terms of the MIT license.
+
 ## Logo
 
-<p align="center">
-  <img src="https://github.com/MattStammers/Pteredactyl/blob/main/src/pteredactyl_webapp/assets/img/Pteredactyl_Logo.jpg" alt="SETT Logo" />
-</p>
+<picture align="center">
+  <img alt="Pteredactyl Logo" src="https://raw.githubusercontent.com/MattStammers/Pteredactyl/main/src/pteredactyl_webapp/assets/img/Pteredactyl_Logo.jpg">
+</picture>
+
+# Abstract
+
+- Authors: Matt Stammers🧪, Cai Davis🥼 and Michael George🩺
+
+- Version 1. 29/06/2024
+
+Clinical patient identifiable information (cPII) presents a significant challenge in natural language processing (NLP) that has yet to be fully resolved but significant progress is being made [1,2].
+
+This is why we created [Pteredactyl](https://pypi.org/project/pteredactyl/) - a python module to help with redaction of clinical free text.
+
+Full [Documentation](https://github.com/MattStammers/Pteredactyl) for the project can be found [here](https://github.com/MattStammers/Pteredactyl)
+
 
 ## Background
 
@@ -356,6 +394,7 @@ We invite the open-source community to collaborate to improve the present result
 ### References:
 1. Chambon PJ, Wu C, Steinkamp JM, Adleberg J, Cook TS, Langlotz CP. Automated deidentification of radiology reports combining transformer and “hide in plain sight” rule-based methods. J Am Med Inform Assoc. 2023 Feb 1;30(2):318–28.
 2. Kotevski DP, Smee RI, Field M, Nemes YN, Broadley K, Vajdic CM. Evaluation of an automated Presidio anonymisation model for unstructured radiation oncology electronic medical records in an Australian setting. Int J Med Inf. 2022 Dec 1;168:104880.
+
 """
 
 description = """