Update README.md

README.md

@@ -19,7 +19,7 @@ tags:
 <!-- Provide a quick summary of what the model is/does. -->
 This Repo contains **LoRA (Low-Rank Adaptation) Adapter** for [unsloth/qwen2.5-coder-32b-instruct-bnb-4bit]
 
-The Adapter was trained for improving model's SQL generation capability in Korean question & multi-db context. 
+The Adapter was trained for **improving model's SQL generation capability** in **Korean question & multi-db context**. 
 
 This adapter was created through **instruction tuning**.
 
@@ -43,7 +43,7 @@ This adapter was created through **instruction tuning**.
 <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
 To use this LoRA adapter, refer to the following code:
 
-### Load Apdater
+### Adapter Loading
 
 ```
 from transformers import BitsAndBytesConfig
@@ -62,7 +62,7 @@ from unsloth import FastLanguageModel
 model_name = "unsloth/Qwen2.5-Coder-32B-Instruct"
 adapter_revision = "checkpoint-200" # checkpoint-100 ~ 350, main(which is checkpoint-384)
 
-bnb_config = get_bnb_config(bit=8)
+bnb_config = get_bnb_config(bit=bit)
 model, tokenizer = FastLanguageModel.from_pretrained(
     model_name=model_name,
     dtype=None,
@@ -111,9 +111,7 @@ SELECT movie_title, movie_release_year, director_name FROM movies ORDER BY movie
 ```
 
 
-### Inference
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
+### Inference - pytorch
 
 ```
 messages = [
@@ -141,17 +139,36 @@ generated_ids = [
 response = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)[0]
 ```
 
-## Bias, Risks, and Limitations
+### Inference - LangChain & HuggingFacePipeline
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+```
+bnb_config = get_bnb_config(bit=bit)
 
-[More Information Needed]
+model, tokenizer = FastLanguageModel.from_pretrained(
+    model_name=model_name,
+    dtype=None,
+    quantization_config=bnb_config,
+)
 
-### Recommendations
+pipe = pipeline("text-generation", model=model, tokenizer=tokenizer, max_new_tokens=max_new_tokens)
+hf_llm = HuggingFacePipeline(pipeline=pipe)
+
+prompt = ChatPromptTemplate.from_messages(
+        [
+            SystemMessage(
+                content=GENERAL_QUERY_PREFIX.format(context=context) + GENERATE_QUERY_INSTRUCTIONS
+            ),
+            (
+                "human",
+                "질문(user_question): {user_question}",
+            ),
+        ]
+    )
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+chain = prompt | hf_llm
 
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+response = chain.invoke({"user_question" : user_question})
+```
 
 
 ## Training Details
@@ -159,14 +176,21 @@ Users (both direct and downstream) should be made aware of the risks, biases and
 ### 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. -->
+https://huggingface.co/datasets/100suping/ko-bird-sql-schema
+- Naive translation of english quesiton to korean quesiton
+
+https://huggingface.co/datasets/won75/text_to_sql_ko
+- Generated data from 100 seed data
 
-[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. -->
 
+https://github.com/100suping/train_with_unsloth
+
 ```
+
 ```
 
 ### Preprocess Functions
@@ -194,39 +218,58 @@ def formatting_prompts_func(examples):
 
 #### 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:** bf16 mixed-precision
+- **Load-in-8bit:** True
+- **LoRA config:**
+  - r=16
+  - lora_alpha=32
+  - lora_dropout=0.0
+  - target_modules = "q proj", "k_proj", "v_proj", "o_proj","gate_proj", "up_proj", "down_proj"
+  - bias = "none"
+  - use_gradient_checkpointing = "unsloth"
+  - use_rslora = False
+  - loftq_config = None
+- **Training Data:** 100suping/ko-bird-sql-schema, won75/text_to_sql_ko
+- **Max_seq_length:** 4096
+- **Save_steps:** 50
+- **Epochs:** 2
+- **Global_steps:** 384
+- **Batch_size:** 16
+- **Gradient_accumulation_steps:** 2
+- **Learning_rate:** 2e-4
+- **Warmup_steps:** 20 
 
 #### Speeds, Sizes, Times [optional]
 
 <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
+- **Device:** G-NAHP-80 from EliceCloud(https://elice.io/ko/products/cloud/on-demand)
+  - A100 80GB PCle (However somehow if i use more than 60GB, error shows up)
+  - CPU 16 vCore
+  - Memory 192 GiB
+  - Storage 100 GiB
 
 ## 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]
-
-## 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]
+```
+@article{hui2024qwen2,
+      title={Qwen2. 5-Coder Technical Report},
+      author={Hui, Binyuan and Yang, Jian and Cui, Zeyu and Yang, Jiaxi and Liu, Dayiheng and Zhang, Lei and Liu, Tianyu and Zhang, Jiajun and Yu, Bowen and Dang, Kai and others},
+      journal={arXiv preprint arXiv:2409.12186},
+      year={2024}
+}
+@article{qwen2,
+      title={Qwen2 Technical Report}, 
+      author={An Yang and Baosong Yang and Binyuan Hui and Bo Zheng and Bowen Yu and Chang Zhou and Chengpeng Li and Chengyuan Li and Dayiheng Liu and Fei Huang and Guanting Dong and Haoran Wei and Huan Lin and Jialong Tang and Jialin Wang and Jian Yang and Jianhong Tu and Jianwei Zhang and Jianxin Ma and Jin Xu and Jingren Zhou and Jinze Bai and Jinzheng He and Junyang Lin and Kai Dang and Keming Lu and Keqin Chen and Kexin Yang and Mei Li and Mingfeng Xue and Na Ni and Pei Zhang and Peng Wang and Ru Peng and Rui Men and Ruize Gao and Runji Lin and Shijie Wang and Shuai Bai and Sinan Tan and Tianhang Zhu and Tianhao Li and Tianyu Liu and Wenbin Ge and Xiaodong Deng and Xiaohuan Zhou and Xingzhang Ren and Xinyu Zhang and Xipin Wei and Xuancheng Ren and Yang Fan and Yang Yao and Yichang Zhang and Yu Wan and Yunfei Chu and Yuqiong Liu and Zeyu Cui and Zhenru Zhang and Zhihao Fan},
+      journal={arXiv preprint arXiv:2407.10671},
+      year={2024}
+}
+```
 
 ## Model Card Authors [optional]
 
-[More Information Needed]
+joonavel[https://github.com/joonavel] from 100suping [https://github.com/100suping]
 
 ## Model Card Contact