Update README.md

README.md

@@ -12,7 +12,7 @@ pipeline_tag: text-generation
 
 # Model Card for ReidLM
 
- ReidLM is a fine-tuned version of Meta's LLaMA 3 model, specifically optimized for generating high-quality, contextually accurate responses in the domain of rare diseases. 
+ ReidLM is a fine-tuned version of Meta's LLaMA 3 model, specifically optimized for generating high-quality, contextually accurate responses in the domain of rare diseases. <br>
  Utilizing the Evol-Instruct methodology, this model was fine-tuned with dataset of over 400 rare diseases.
 
 
@@ -26,7 +26,7 @@ pipeline_tag: text-generation
 - **Model type:** Transformer-based Large Language Model (LLM)
 - **Language(s) (NLP):** English
 - **License:** [More Information Needed]
-- **Finetuned from model [optional]:** Meta-Llama-3-8B-Instruct
+- **Finetuned from model:** Meta-Llama-3-8B-Instruct
 
 ## Uses
 
@@ -36,15 +36,15 @@ ReidLM is designed for direct use in generating insightful and reliable informat
 
 ReidLM is specifically designed for generating information related to rare diseases and should not be used for the following purposes:
 
-  -Non-Medical Domains: ReidLM is optimized for rare disease information and may not perform well in other domains such as finance, law, general health conditions, or any other non-medical fields.
+  -Non-Medical Domains: ReidLM is optimized for rare disease information and may not perform well in other domains such as finance, law, general health conditions, or any other non-medical fields.<br>
 
   -General Conversational AI: While capable of generating detailed information on rare diseases, ReidLM may not be suitable for general conversational AI tasks that require a broad understanding of various topics.
 
 
 ## Bias, Risks, and Limitations
 
-ReidLM, like all large language models, has inherent biases and limitations that users should be aware of:
-    -Ethical Concerns: There is a risk of over-reliance on AI for medical decisions, which should always be validated by healthcare professionals.
+ReidLM, like all large language models, has inherent biases and limitations that users should be aware of:<br>
+    -Ethical Concerns: There is a risk of over-reliance on AI for medical decisions, which should always be validated by healthcare professionals.<br>
     -Accuracy: While the model strives for accuracy, it may generate incorrect or incomplete information, especially in highly specialized or novel cases.
 
 <!---### Recommendations
@@ -53,7 +53,7 @@ ReidLM, like all large language models, has inherent biases and limitations that
 
 Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.--->
 
-## How to Get Started with the Model
+## Getting Started with the Model
 
 Use the code below to get started with the model.
 ## Use with Transformers AutoModelForCausalLM
@@ -93,7 +93,18 @@ print(generated_text)
 
 #### 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 -->
+- **Training regime:** 
+    num_train_epochs=3, <br>
+    per_device_train_batch_size=4,<br>
+    gradient_accumulation_steps=2,<br>
+    optim="paged_adamw_8bit",<br>
+    save_steps=1000,<br>
+    logging_steps=30,<br>
+    learning_rate=2e-4,<br>
+    weight_decay=0.01,<br>
+    fp16=True,<br>
+    max_grad_norm=1.0,<br>
+    warmup_ratio=0.1<br><!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
 
 <!---#### Speeds, Sizes, Times [optional]