Update README.md

README.md

@@ -1,199 +1,168 @@
 ---
 library_name: transformers
-tags: []
+tags: [
+  "maternal-healthcare",
+  "causal-language-model",
+  "Llama",
+  "transformers",
+  "healthcare-chatbot",
+  "open-source",
+  "fine-tuning"
+]
 ---
 
-# Model Card for Model ID
-
-<!-- Provide a quick summary of what the model is/does. -->
-
+# Model Card for MamaBot-Llama-1
 
+MamaBot-Llama-1 is a fine-tuned large language model developed by HelpMum to assist with maternal healthcare by providing accurate and reliable answers to questions about pregnancy and childbirth. The model has been fine-tuned on Llama 3.1 8b-instruct using a dataset of maternal healthcare questions and answers.
 
 ## Model Details
 
 ### Model Description
 
-<!-- Provide a longer summary of what this model is. -->
-
 This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
 
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+- **Developed by:** HelpMum
+- **Shared by [optional]:** HelpMum
+- **Model type:** Causal Language Model (Llama 3.1 8b-instruct)
+- **Language(s) (NLP):** English
+- **License:** Apache-2.0
+- **Finetuned from model:** Llama 3.1 8b-instruct
 
-### Model Sources [optional]
+### Model Sources
 
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- **Repository:** [MamaBot-Llama-1 on Hugging Face](https://huggingface.co/HelpMumHQ/mamabot-llama-1)
 
 ## Uses
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
 ### Direct Use
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+MamaBot-Llama-1 can be directly used to provide answers to maternal healthcare questions, offering guidance and support to mothers during pregnancy and childbirth.
 
-[More Information Needed]
+### Downstream Use
 
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
+The model can be integrated into healthcare applications, chatbots, or other systems that aim to provide maternal healthcare support.
 
 ### Out-of-Scope Use
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
+The model is not intended for use in medical diagnosis or treatment without the supervision of a qualified healthcare professional. It should not be used for malicious purposes or misinformation.
 
 ## Bias, Risks, and Limitations
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+The model was trained on a specific dataset related to maternal healthcare. While it aims to provide accurate and supportive information, users should be aware of the following:
 
-[More Information Needed]
+- **Bias:** The model may reflect biases present in the training data, which could affect the quality and impartiality of the responses.
+- **Risks:** Users should not rely solely on the model for critical medical decisions. Always consult with a healthcare professional for medical advice.
+- **Limitations:** The model's responses are based on the data it was trained on and may not cover all possible scenarios or latest medical guidelines.
 
 ### Recommendations
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+Users (both direct and downstream) should be made aware of the risks, biases, and limitations of the model. It is recommended to use the model as a supplementary tool and not as a primary source of medical advice.
 
 ## How to Get Started with the Model
 
 Use the code below to get started with the model.
 
-[More Information Needed]
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
 
-## Training Details
+model_id = "HelpMumHQ/mamabot-llama-1"
+tokenizer = AutoTokenizer.from_pretrained(model_id)
+model = AutoModelForCausalLM.from_pretrained(model_id)
 
-### Training Data
+messages = [
+    {
+        "role": "user",
+        "content": "Why might mothers not realize they are already pregnant in the first two weeks?"
+    }
+]
 
-<!-- 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. -->
+prompt = tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
+inputs = tokenizer(prompt, return_tensors='pt', padding=True, truncation=True).to("cuda")
+outputs = model.generate(**inputs, max_length=100, num_return_sequences=1)
+text = tokenizer.decode(outputs[0], skip_special_tokens=True)
+print(text.split("assistant")[1])
+```
 
-[More Information Needed]
+## Training Details
 
-### Training Procedure
+### Training Data
 
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
+The training data consists of a HelpMum-created dataset of maternal healthcare questions and answers covering all stages of pregnancy up to birth.
 
-#### Preprocessing [optional]
+### Training Procedure
 
-[More Information Needed]
+#### Preprocessing
 
+The dataset was cleaned and formatted to align with the required input format for the model.
 
 #### Training Hyperparameters
 
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
+- **Training regime:** torch.bfloat16
+- **Optimizer:** paged_adamw_32bit
+- **Learning rate:** 2e-4
 
 ## Evaluation
 
-<!-- This section describes the evaluation protocols and provides the results. -->
-
 ### Testing Data, Factors & Metrics
 
 #### Testing Data
 
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
+The testing data is a subset of the training dataset, split into training and testing sets.
 
 #### Factors
 
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
+The evaluation considered the training and validation losses.
 
 #### Metrics
 
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
+The model was evaluated based on training loss and validation loss metrics.
 
 ### Results
 
-[More Information Needed]
+- **Training Loss:** 0.4654
+- **Validation Loss:** 0.5168
 
 #### Summary
 
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
+The model showed consistent performance with a training loss of 0.4654 and a validation loss of 0.5168, indicating its effectiveness in answering maternal healthcare questions.
 
 ## Environmental Impact
 
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-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:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
+- **Hardware Type:** GPU
 
-## Technical Specifications [optional]
+## Technical Specifications
 
 ### Model Architecture and Objective
 
-[More Information Needed]
+The model is based on the Llama 3.1 8b-instruct architecture and aims to provide accurate and supportive responses to maternal healthcare questions.
 
 ### Compute Infrastructure
 
-[More Information Needed]
-
 #### Hardware
 
-[More Information Needed]
+The model was trained using GPUs to handle the computational load of fine-tuning a large language model.
 
 #### Software
 
-[More Information Needed]
-
-## Citation [optional]
+The training and inference were conducted using the Hugging Face Transformers library and other associated tools.
 
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
+## Citation
 
 **BibTeX:**
 
-[More Information Needed]
+```bibtex
+@misc{mamabot-llama-1,
+  author = {HelpMum},
+  title = {MamaBot-Llama-1},
+  year = {2024},
+  howpublished = {\url{https://huggingface.co/HelpMumHQ/mamabot-llama-1}},
+}
+```
 
 **APA:**
 
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Model Card Authors [optional]
-
-[More Information Needed]
+HelpMum. (2024). MamaBot-Llama-1. Retrieved from https://huggingface.co/HelpMumHQ/mamabot-llama-1
 
 ## Model Card Contact
 
-[More Information Needed]
+For more information, please contact [[email protected]](mailto:[email protected]).