Update README.md

README.md

@@ -1,238 +1,111 @@
----
-library_name: transformers
-tags:
-- unsloth
----
-
-# Model Card for Model ID
-
-Base Model: unsloth/DeepSeek-R1-Distill-Llama-8B
-Fine-Tuning Dataset: hieulum/bacsiAI (first 200 rows)
-LoRA Parameters: r=16, lora_alpha=16, target modules, etc.
-Training Details: 1 epoch, 60 steps, batch size 8, learning rate 2e-4
-Usage Instructions:
-  from unsloth import FastLanguageModel
-  model, tokenizer = FastLanguageModel.from_pretrained(
-      model_name="unsloth/DeepSeek-R1-Distill-Llama-8B",
-      max_seq_length=1024,
-      load_in_4bit=True,
-  )
-  model = FastLanguageModel.load_peft_model(model, "your_username/DeepSeek-R1-LoRA-medical")
-
-Programmatically Create a Model Card: Use the huggingface_hub library to generate a basic model card:
-  from huggingface_hub import ModelCard, ModelCardData
-  
-  card_data = ModelCardData(
-      language="en",
-      license="apache-2.0",
-      tags=["medical", "LoRA", "unsloth", "DeepSeek-R1"],
-      datasets=["hieulum/bacsiAI"],
-  )
-  card = ModelCard.from_template(
-      card_data,
-      model_name="DeepSeek-R1-LoRA-medical",
-      model_description="LoRA adapters for medical Q&A, fine-tuned on hieulum/bacsiAI dataset using unsloth.",
-      base_model="unsloth/DeepSeek-R1-Distill-Llama-8B",
-      training_details="Fine-tuned with r=16, lora_alpha=16, 1 epoch, 60 steps, batch size 8, learning rate 2e-4.",
-      usage="Load with unsloth: `FastLanguageModel.load_peft_model(model, 'your_username/DeepSeek-R1-LoRA-medical')`",
+# DeepSeek-R1-LoRA-medical
+
+## Giới thiệu
+
+Đây là bộ LoRA adapters được fine-tune trên mô hình gốc `unsloth/DeepSeek-R1-Distill-Llama-8B` để hỗ trợ trả lời các câu hỏi y khoa. Bộ adapters này được huấn luyện trên tập dữ liệu `hieulum/bacsiAI` (200 mẫu đầu tiên) với cấu hình LoRA tối ưu, giúp cải thiện khả năng trả lời các câu hỏi về chẩn đoán, điều trị và lập kế hoạch điều trị y tế.
+
+### Thông tin mô hình
+- **Mô hình gốc**: `unsloth/DeepSeek-R1-Distill-Llama-8B`
+- **Dataset**: `hieulum/bacsiAI` (200 mẫu)
+- **Cấu hình LoRA**:
+  - Rank (`r`): 16
+  - LoRA alpha: 16
+  - Các module mục tiêu: `q_proj`, `k_proj`, `v_proj`, `o_proj`, `gate_proj`, `up_proj`, `down_proj`
+- **Thông tin huấn luyện**:
+  - Số epoch: 1
+  - Tổng số bước: 60
+  - Batch size hiệu quả: 8 (2 per device × 4 gradient accumulation steps)
+  - Learning rate: 2e-4
+  - Optimizer: AdamW 8-bit
+- **Kích thước LoRA adapters**: ~168 MB
+- **Giấy phép**: Apache 2.0 (hoặc thay bằng giấy phép bạn chọn)
+
+## Các file trong repository
+- `adapter_config.json`: Cấu hình LoRA adapters.
+- `adapter_model.safetensors`: Trọng số LoRA adapters (168 MB).
+- `tokenizer_config.json`: Cấu hình tokenizer.
+- `tokenizer.json`: Từ vựng tokenizer.
+- `special_tokens_map.json`: Ánh xạ các token đặc biệt.
+
+## Hướng dẫn sử dụng
+
+### Yêu cầu
+- **Thư viện**:
+  ```bash
+  pip install unsloth transformers huggingface_hub torch
+  ```
+- **Phần cứng**: GPU với ít nhất 16GB VRAM (ví dụ: NVIDIA Tesla T4).
+- **Python**: 3.8 hoặc cao hơn.
+- **Hugging Face token**: Để tải mô hình gốc (nếu cần).
+
+### Bước 1: Cài đặt môi trường
+Cài đặt các thư viện cần thiết:
+```bash
+pip install unsloth==2024.9 transformers huggingface_hub torch==2.4.0
+```
+
+### Bước 2: Tải mô hình gốc và LoRA adapters
+Sử dụng đoạn code sau để tải mô hình gốc và áp dụng LoRA adapters:
+
+```python
+from unsloth import FastLanguageModel
+import torch
+
+# Tải mô hình gốc
+model, tokenizer = FastLanguageModel.from_pretrained(
+    model_name="unsloth/DeepSeek-R1-Distill-Llama-8B",
+    max_seq_length=1024,  # Có thể điều chỉnh
+    load_in_4bit=True,    # Sử dụng 4-bit quantization để tiết kiệm bộ nhớ
+    token="your_hugging_face_token",  # Thay bằng token của bạn
 )
 
-# Save the model card locally
-card.save("model_card.md")
+# Tải LoRA adapters
+model = FastLanguageModel.load_peft_model(
+    model,
+    "hieulum/DeepSeek-R1-LoRA-BacsiAI"  
 
-# Upload the model card
-from huggingface_hub import upload_file
-upload_file(
-    path_or_fileobj="model_card.md",
-    path_in_repo="README.md",
-    repo_id=repo_id,
-)
-
-## 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]
-
-### Model Sources [optional]
-
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-
-## 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]
-
-### 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.
-
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
-
-[More Information Needed]
-
-## 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]
-
-
-#### 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]
-
-## 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]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
-
-## 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]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## 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:**
+# Chuẩn bị mô hình cho inference
+model = FastLanguageModel.for_inference(model)
+```
 
-[More Information Needed]
+### Bước 3: Chạy inference
+Ví dụ về cách chạy inference với một câu hỏi y khoa:
 
-## Glossary [optional]
+```python
+# Chuẩn bị input
+question = "Phương pháp điều trị tăng huyết áp là gì?"
+inputs = tokenizer(question, return_tensors="pt").to("cuda")
 
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
+# Tạo output
+outputs = model.generate(**inputs, max_new_tokens=128, temperature=0.7)
+response = tokenizer.decode(outputs[0], skip_special_tokens=True)
 
-[More Information Needed]
+print(response)
+```
 
-## More Information [optional]
+### Lưu ý
+- **Max sequence length**: Được đặt thành 1024 trong code trên để tiết kiệm bộ nhớ. Nếu bạn cần xử lý các chuỗi dài hơn, tăng `max_seq_length` (ví dụ: 2048) nhưng hãy đảm bảo GPU có đủ VRAM.
+- **4-bit quantization**: Được sử dụng để giảm yêu cầu bộ nhớ. Nếu bạn có GPU mạnh hơn, có thể tắt bằng cách đặt `load_in_4bit=False`.
+- **Hugging Face token**: Cần thiết để tải mô hình gốc từ `unsloth`. Đảm bảo bạn đã đăng nhập hoặc cung cấp token qua `huggingface_hub.login()`.
 
-[More Information Needed]
+### Đăng nhập Hugging Face (nếu cần)
+Nếu bạn chưa đăng nhập, chạy:
+```python
+from huggingface_hub import login
+login(token="your_hugging_face_token")
+```
 
-## Model Card Authors [optional]
+Hoặc qua terminal:
+```bash
+huggingface-cli login
+```
 
-[More Information Needed]
+## Hiệu suất
+Bộ LoRA adapters này được tối ưu cho các câu hỏi y khoa, đặc biệt là chẩn đoán và điều trị. Mô hình có thể tạo ra các câu trả lời logic với chuỗi suy nghĩ (chain-of-thought) rõ ràng, nhờ vào định dạng prompt đặc biệt trong quá trình fine-tune.
 
-## Model Card Contact
+## Liên hệ
+Nếu bạn gặp vấn đề hoặc có câu hỏi, vui lòng mở issue trên repository này hoặc liên hệ qua Hugging Face.
 
-[More Information Needed]
+## Lời cảm ơn
+- Cảm ơn `unsloth` và Hugging Face đã cung cấp các công cụ mạnh mẽ để fine-tune và chia sẻ mô hình.
+- Cảm ơn tác giả dataset `hieulum/bacsiAI` đã cung cấp dữ liệu chất lượng.