Update README.md

README.md

@@ -21,20 +21,69 @@ This gemma2 model was trained 2x faster with [Unsloth](https://github.com/unslot
 
 [<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)
 
+## Model Overview
+This fine-tuned LoRA model assists with drafting patent specifications based on a general description of an invention.
+The base model is unsloth/gemma-2-2b-it-bnb-4bit, and the fine-tuning was carried out using unsloth.
 
-## 모델 소개
+## Dataset
+The dataset used for fine-tuning includes a combination of research paper 
+summary datasets from AI-Hub and patent claims data directly retrieved from KIPRIS 
+(Korea Intellectual Property Rights Information Service).
 
-해당 모델은 대략적인 발명품의 설명을 입력으로 받아 특허 명세서 작성을 도와주는 파인튜닝된 roLA 모델입니다.
-베이스 모델은 unsloth/gemma-2-2b-it-bnb-4bit이며, unsloth를 이용해 파인튜닝을 했습니다.
-
-
-## 데이터셋
+Model Training
+The model was trained using LoRA (Low-Rank Adaptation). The following code was used for training:
+```
+model = FastLanguageModel.get_peft_model(
+    model,
+    r = 16, # Choose any number > 0 ! Suggested 8, 16, 32, 64, 128
+    target_modules = ["q_proj", "k_proj", "v_proj", "o_proj",
+                      "gate_proj", "up_proj", "down_proj",],
+    lora_alpha = 16,
+    lora_dropout = 0, # Supports any, but = 0 is optimized
+    bias = "none",    # Supports any, but = "none" is optimized
+    # [NEW] "unsloth" uses 30% less VRAM, fits 2x larger batch sizes!
+    use_gradient_checkpointing = "unsloth", # True or "unsloth" for very long context
+    random_state = 3407,
+    use_rslora = False,  # We support rank stabilized LoRA
+    loftq_config = None, # And LoftQ
+)
+```
+```
+from trl import SFTTrainer
+from transformers import TrainingArguments
+from unsloth import is_bfloat16_supported
+
+trainer = SFTTrainer(
+    model = model,
+    tokenizer = tokenizer,
+    train_dataset = train_data,
+    max_seq_length = max_seq_length,
+    formatting_func = generate_prompt,
+    dataset_num_proc = 2,
+    packing = False, # Can make training 5x faster for short sequences.
+    args = TrainingArguments(
+        per_device_train_batch_size = 2,
+        gradient_accumulation_steps = 4,
+        warmup_steps = 5,
+        num_train_epochs = 1, # Set this for 1 full training run.
+        # max_steps = 100,
+        learning_rate = 2e-4,
+        fp16 = not is_bfloat16_supported(),
+        bf16 = is_bfloat16_supported(),
+        logging_steps = 10,
+        optim = "adamw_8bit",
+        weight_decay = 0.01,
+        lr_scheduler_type = "linear",
+        seed = 3407,
+        output_dir = "outputs",
+    ),
+)
+```
 
-데이터셋은 AI-Hub에 있는 논문자료 요약 데이터 셋과 키프리스에서 직접 청구항을 가져와 조합한 데이터셋을 이용했습니다.
 
-## 모델 사용법
+## How to Use the Model
 
-1. unsloth를 설치합니다
+1. Install unsloth:
 ```
 %%capture
 !pip install unsloth
@@ -47,7 +96,7 @@ if torch.cuda.get_device_capability()[0] >= 8:
     !pip install --no-deps packaging ninja einops "flash-attn>=2.6.3"
 ```
 
-2. 모델을 불러옵니다.
+2. Load the fine-tuned model and use it for inference:
 ```
 from unsloth import FastLanguageModel
 import torch
@@ -57,14 +106,14 @@ load_in_4bit = True
 token = "your-huggingface-token"
 
 model, tokenizer = FastLanguageModel.from_pretrained(
-    model_name = "limecoding/gemma2-2b-it-finetuned-patent-lora",
+    model_name = "limecoding/gemma2-2b-it-finetuned-patent",
     max_seq_length = max_seq_length,
     dtype = dtype,
     load_in_4bit = load_in_4bit,
     token = token
 )
 ```
-3. 프롬프트를 작성하여 텍스트 생성합니다.
+3. Write a prompt and generate text:
 ```
 input = """
 상술한 과제를 해결하기 위하여, 본 고안은 내부에 보관할 물건을 넣을 수 있는 기본 내장 공간과 이를 둘러싼
@@ -105,10 +154,33 @@ inputs = tokenizer(
     r"""<bos><start_of_turn>user
 다음 과제해결수단을 보고 발명의 명칭, 기술분야, 청구항을 뽑아주세요.: {}<end_of_turn>
 <start_of_turn>model""".format(input)
-# train_data[0]["과제의 해결 수단"]
 ], return_tensors = "pt").to("cuda")
 
 from transformers import TextStreamer
 text_streamer = TextStreamer(tokenizer)
 _ = model.generate(**inputs, streamer = text_streamer, max_new_tokens = 1000)
-```
+```
+
+
+## Model Results
+The model was tested using the "Means to Solve the Problem" section from actual patent specifications. 
+When compared with real patent documents, the model generated content that was relatively similar in 
+structure and meaning.
+```
+[발명의 명칭]
+가방
+
+
+[기술분야]
+본 발명은 가방에 관한 것으로, 보다 상세하게는 확장 가능한 가방에 관한 것이다.
+
+
+[청구항]
+내부에 보관할 물건을 넣을 수 있는 기본 내장 공간과 이를 둘러싼 외피를 포함하는 가방에 ���어서,
+
+상기 외피에는 열리고 닫히는 확장 외피 지퍼가 형성되어 있고,
+
+상기 확장 외피 지퍼의 내측에는 상기 확장 외피 지퍼가 열리는 경우 펼쳐지는 확장 내피를 더 포함하되,
+
+상기 확장 내피의 내측으로 추가 공간이 형성되어 추가 수납공간을 구비토록 하는 것을 특징으로 하는 추가 수납공간이 구비된 가방.<end_of_turn>
+```