Update README.md

README.md

@@ -32,12 +32,12 @@ This is a LoRA fine-tuned version of **microsoft/Phi-4-mini-instruct** for Afric
 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:** Daniel Ihenacho
-- **Funded by [optional]:** Daniel Ihenacho
-- **Shared by [optional]:** Daniel Ihenacho
+- **Funded by:** Daniel Ihenacho
+- **Shared by:** Daniel Ihenacho
 - **Model type:** Text Generation
 - **Language(s) (NLP):** English
 - **License:** mit
-- **Finetuned from model [optional]:** [More Information Needed]
+- **Finetuned from model:** [More Information Needed]
 
 ### Model Sources [optional]
 
@@ -49,64 +49,106 @@ This is the model card of a 🤗 transformers model that has been pushed on the
 
 ## 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. -->
-
-[More Information Needed]
-
-### 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]
+This can be used for QA datasets about African History
 
 ### Out-of-Scope Use
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### 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.
+Can be used beypnd African History but should not.
 
 ## How to Get Started with the Model
 
-Use the code below to get started with the model.
-
-[More Information Needed]
+```python
+from transformers import pipeline
+from transformers import (
+    AutoTokenizer, 
+    AutoModelForCausalLM)
+from peft import LoraConfig, get_peft_model, PeftModel
+
+
+model_id = "microsoft/Phi-4-mini-instruct"
+
+tokeniser = AutoTokenizer.from_pretrained(model_id)
+
+# load base model
+model  = AutoModelForCausalLM.from_pretrained(
+    model_id,
+    device_map = "auto",
+    torch_dtype = torch.bfloat16,
+    trust_remote_code = False
+)
+
+# Load the fine-tuned LoRA model
+lora_id = "DannyAI/phi4_african_history_lora"
+lora_model = PeftModel.from_pretrained(
+    model,lora_id
+)
+
+generator = pipeline(
+    "text-generation",
+    model=lora_model,
+    tokenizer=tokeniser,
+)
+question = "What is the significance of African feminist scholarly activism in contemporary resistance movements?"
+def generate_answer(question)->str:
+    """Generates an answer for the given question using the fine-tuned LoRA model.
+    """
+    messages = [
+        {"role": "system", "content": "You are a helpful AI assistant specialised in African history which gives concise answers to questions asked."},
+        {"role": "user", "content": question}
+    ]
+    
+    # pipeline() returns a list of dicts; return_full_text=False gives only the assistant's reply
+    output = generator(
+        messages, 
+        max_new_tokens=2048, 
+        temperature=0.1, 
+        do_sample=False,
+        return_full_text=False
+    )
+    return output[0]['generated_text'].strip()
+```
+```
+# Example output
+African feminist scholarly activism is significant in contemporary resistance movements as it provides a critical framework for understanding and addressing the specific challenges faced by African women in the context of global capitalism, neocolonialism, and patriarchal structures.
+```
 
 ## Training Details
 
 ### Training Data
 
-<!-- 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. -->
-
-[More Information Needed]
-
-### 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]
-
-[More Information Needed]
+| Step | Training Loss | Validation Loss |
+|------|--------------|----------------|
+| 100  | 1.643900 | 1.650120 |
+| 200  | 1.548300 | 1.577856 |
+| 300  | 1.581000 | 1.551598 |
+| 400  | 1.578900 | 1.538108 |
+| 500  | 1.498800 | 1.528269 |
+| 600  | 1.401300 | 1.518312 |
+| 700  | 1.520000 | 1.513678 |
+| 800  | 1.436400 | 1.506603 |
+| 900  | 1.545600 | 1.504393 |
+| 1000 | 1.439800 | 1.502365 |
+| 1100 | 1.452100 | 1.500665 |
+| 1200 | 1.466000 | 1.494793 |
+| 1300 | 1.408300 | 1.493954 |
+| 1400 | 1.508900 | 1.493219 |
+| 1500 | 1.487500 | 1.493616 |
+| 1600 | 1.383300 | 1.489923 |
+| 1700 | 1.534100 | 1.489187 |
+| 1800 | 1.468800 | 1.489143 |
+| 1900 | 1.405100 | 1.488410 |
+| 2000 | 1.509100 | 1.487043 |
+| 2100 | 1.435800 | 1.488957 |
+| 2200 | 1.434400 | 1.487890 |
+| 2300 | 1.416800 | 1.488166 |
+| 2400 | 1.416600 | 1.487361 |
+| 2500 | 1.439200 | 1.487180 |
+| 2600 | 1.450000 | 1.486632 |
 
 
 #### 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]