Update README.md

README.md

@@ -21,21 +21,13 @@ This model simplifies complex medical texts to a 6th-grade reading level, enhanc
 
 This model uses advanced natural language processing (NLP) algorithms to translate complex medical information into a format that is accessible to individuals with a 6th-grade reading level. The goal is to improve comprehension and health outcomes for patients with low health literacy.
 
-- **Developed by:** [WernickeAI]
+- **Developed by:** WernickeAI
 - **Funded by [optional]:** [More Information Needed]
 - **Shared by [optional]:** [More Information Needed]
-- **Model type:** [Text Simplification]
-- **Language(s) (NLP):** [English]
+- **Model type:** Text Simplification
+- **Language(s) (NLP):** English
 - **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [tiiuae/falcon-40b]
-
-### Model Sources [optional]
-
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- **Finetuned from model:** tiiuae/falcon-40b
 
 ## Uses
 
@@ -45,25 +37,25 @@ This model uses advanced natural language processing (NLP) algorithms to transla
 
 <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 
-[The model can be used directly to simplify patient education materials to improve accessibility and comprehension.]
+The model can be used directly to simplify patient education materials to improve accessibility and comprehension.
 
 ### Downstream Use [optional]
 
 <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
 
-[The model can be integrated into healthcare platforms and patient portals to provide simplified information, aiding patients in understanding their medical conditions and treatment plans.]
+The model can be integrated into healthcare platforms and patient portals to provide simplified information, aiding patients in understanding their medical conditions and treatment plans.
 
 ### Out-of-Scope Use
 
 <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
-[The model should not be used for generating medical advice or instructions without proper validation from healthcare professionals to avoid misinformation.]
+The model should not be used for generating medical advice or instructions without proper validation from healthcare professionals to avoid misinformation.
 
 ## Bias, Risks, and Limitations
 
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
-[The model may not fully capture all nuances of medical information, leading to oversimplification or loss of critical details. There is also a risk of bias in the training data affecting the output.]
+The model may not fully capture all nuances of medical information, leading to oversimplification or loss of critical details. There is also a risk of bias in the training data affecting the output.
 
 ### Recommendations
 
@@ -75,7 +67,11 @@ Users should validate the simplified text with healthcare professionals to ensur
 
 Use the code below to get started with the model.
 
-[More Information Needed]
+'''python
+prompt = """
+<user>: Convert this text to reading level 6: What are the complications? What are the complications? Nearly 88,000 people die from alcohol-related causes each year in the US, making alcohol use the 4th leading preventable cause of death. Drinking at an increased risk level raises your chance of:  Accidents, injuries, and aggression. Drinking too much increases your risk for every type of injury and violence. Alcohol is a factor in about 60% of fatal burn injuries, drownings, and murders; 50% of severe trauma injuries and sexual assaults; and 40% of fatal crashes and falls.  Physical health problems. Heavy drinkers have a greater chance of liver and heart disease, stroke, digestive problems, and some types of cancer. Theyre also more likely to have problems with sexual function and premature aging.  Emotional and cognitive problems. People who drink too much are more prone to anxiety and depression. They may have trouble sleeping, remembering things, and solving problems.  Problems with relationships, work, and studies. Heavy drinking can interfere with your interactions and performance in every area of your life.  Birth defects. Drinking during pregnancy can cause brain damage and deformities in the baby. Since scientists dont know whether any amount of alcohol is safe for a developing baby, women who are pregnant or trying to become pregnant should not drink.  Alcoholism and alcohol use disorders. Drinking at an increased risk level raises your chance of developing an alcohol use disorder. How is it treated? Your medical provider may refer you to an addiction specialist for consultation if there is a perceived risk. If your risk is moderate to high, you may need to have treatment \(at an outpatient or in an acute hospital setting\) to help you manage withdrawal symptoms and reduce your risks associated with this disorder. Your medical provider may also prescribe medicines to help you to manage your symptoms. 
+<assistant>:
+""".strip()'''
 
 ## Training Details
 
@@ -83,30 +79,30 @@ Use the code below to get started with the model.
 
 <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
 
-[The model was trained on a comprehensive dataset of medical texts, including patient handouts and educational materials, processed to ensure readability compliance with NIH and AMA guidelines.]
+The model was trained on a comprehensive dataset of medical texts, including patient handouts and educational materials, processed to ensure readability compliance with NIH and AMA guidelines.
 
 ### Training Procedure
 
 <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
 
-#### Preprocessing [optional]
+#### Preprocessing
 
-[Medical texts were preprocessed using readability assessments such as SMOG, Flesch-Kincaid, and Gunning Fog to ensure the dataset's appropriateness for training the simplification model.]
+Medical texts were preprocessed using readability assessments such as SMOG, Flesch-Kincaid, and Gunning Fog to ensure the dataset's appropriateness for training the simplification model.
 
 
 #### Training Hyperparameters
 
-- **Training regime:** [
+- **Training regime:**
 Training regime: fp16 mixed precision
 Optimizer: AdamW
 Learning rate: 5e-5
-Batch size: 32] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
+Batch size: 32 <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
 
-#### Speeds, Sizes, Times [optional]
+#### Speeds, Sizes, Times
 
 <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
 
-[Training was conducted over 10 epochs, with checkpoints saved at regular intervals to monitor progress and performance.]
+Training was conducted over 10 epochs, with checkpoints saved at regular intervals to monitor progress and performance.
 
 ## Evaluation
 
@@ -118,33 +114,33 @@ Batch size: 32] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-m
 
 <!-- This should link to a Dataset Card if possible. -->
 
-[More Information Needed]
+The testing data comprised patient-centered materials not included in the training set, evaluated for readability and comprehension improvement.
 
 #### Factors
 
 <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
 
-[More Information Needed]
+Evaluation factors included readability scores and patient comprehension levels.
 
 #### Metrics
 
 <!-- These are the evaluation metrics being used, ideally with a description of why. -->
 
-[More Information Needed]
+Metrics included SMOG, Flesch-Kincaid, and Gunning Fog scores, along with patient comprehension assessment through usability testing.
 
 ### Results
 
-[More Information Needed]
+The model demonstrated significant improvement in readability scores and patient comprehension compared to existing AI technologies.
 
 #### Summary
 
+The AI-driven tool effectively simplified medical texts to a 6th-grade reading level, enhancing understanding and engagement among patients with low health literacy.
 
-
-## Model Examination [optional]
+## Model Examination
 
 <!-- Relevant interpretability work for the model goes here -->
 
-[The model's outputs were reviewed by healthcare professionals to ensure accuracy and completeness.]
+The model's outputs were reviewed by healthcare professionals to ensure accuracy and completeness.
 
 ## Environmental Impact
 
@@ -152,58 +148,44 @@ Batch size: 32] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-m
 
 Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
 
-- **Hardware Type:** [GPU (NVIDIA A100)]
-- **Hours used:** [120 hours]
-- **Cloud Provider:** [AWS]
-- **Compute Region:** [US East (N. Virginia)]
-- **Carbon Emitted:** [500 kg CO2eq]
+- **Hardware Type:** GPU (NVIDIA A100)
+- **Hours used:** 120 hours
+- **Cloud Provider:** AWS
+- **Compute Region:** US East (N. Virginia)
+- **Carbon Emitted:** 500 kg CO2eq
 
 ## Technical Specifications [optional]
 
 ### Model Architecture and Objective
 
-[The model is based on a sequence-to-sequence transformer architecture fine-tuned for text simplification.]
+The model is based on a sequence-to-sequence transformer architecture fine-tuned for text simplification.
 
 ### Compute Infrastructure
 
-[More Information Needed]
-
 #### Hardware
 
-[Training was conducted on NVIDIA A100 GPUs.]
+Training was conducted on NVIDIA A100 GPUs.
 
 #### Software
 
-[The model was developed on Google Colab using Python and Hugging Face's Transformers library.]
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
+The model was developed on Google Colab using Python and Hugging Face's Transformers library.
 
-## Glossary [optional]
+## Glossary
 
 <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
 
-[
 Health Literacy: The ability to obtain, process, and understand basic health information to make appropriate health decisions.
-Readability Assessments: Tools used to evaluate the reading level of a text, such as SMOG, Flesch-Kincaid, and Gunning Fog.]
+Readability Assessments: Tools used to evaluate the reading level of a text, such as SMOG, Flesch-Kincaid, and Gunning Fog.
 
-## More Information [optional]
+## More Information
 
-[or further details and inquiries, please contact the model author.]
+For further details and inquiries, please contact the model author.
 
-## Model Card Authors [optional]
+## Model Card Authors
 
-[Clark Parry]
+Clark Parry
 
 ## Model Card Contact
 
-[More Information Needed]
+Visit [website] for business inquiries.
+Contact author for model inquiries.