Update README.md

README.md

@@ -1,19 +1,19 @@
 ---
 license: mit
 language:
-- en
-- ko
-- code
+  - en
+  - ko
+  - code
 library_name: transformers
 tags:
-- code-llama
-- code-review
-- fine-tuning
-- SFT
-- LoRA
+  - code-llama
+  - code-review
+  - fine-tuning
+  - SFT
+  - LoRA
 pipeline_tag: text-generation
 base_model:
-- codellama/CodeLlama-7b-hf
+  - codellama/CodeLlama-7b-hf
 ---
 
 # Model Card for codellama-7b-code-review
@@ -23,11 +23,11 @@ base_model:
 ## Model Details / 모델 상세 정보
 
 <details>
-<summary><strong>English</strong></summary>
+<summary><strong>🇺🇸 English</strong></summary>
 
 This model is fine-tuned from Meta's `codellama/CodeLlama-7b-hf` to review and provide feedback on code changes (`diffs`) from GitHub Pull Requests. It has been primarily trained on JavaScript and React code reviews, aiming to generate constructive feedback from a senior engineer's perspective on topics like code quality, architecture, performance, and conventions.
 
-- **Developed by:** [ken123777](https://huggingface.co/ken123777)
+- **Developed by:** [ken12377](https://huggingface.co/ken12377)
 - **Model type:** Causal Language Model
 - **Language(s):** English, Korean, Diff format
 - **License:** apache-2.0
@@ -36,11 +36,11 @@ This model is fine-tuned from Meta's `codellama/CodeLlama-7b-hf` to review and p
 </details>
 
 <details>
-<summary><strong>한국어</strong></summary>
+<summary><strong>🇰🇷 한국어</strong></summary>
 
 이 모델은 Meta의 `codellama/CodeLlama-7b-hf` 모델을 기반으로, GitHub Pull Request의 코드 변경사항(`diff`)을 리뷰하고 피드백을 제공하도록 파인튜닝되었습니다. 주로 JavaScript와 React 코드 리뷰에 중점을 두고 학습되었으며, 시니어 엔지니어의 관점에서 코드 품질, 아키텍처, 성능, 컨벤션 등에 대한 건설적인 피드백을 생성하는 것을 목표로 합니다.
 
-- **개발자:** [ken123777](https://huggingface.co/ken123777)
+- **개발자:** [ken12377](https://huggingface.co/ken12377)
 - **모델 종류:** 인과 관계 언어 모델 (Causal Language Model)
 - **언어:** 영어, 한국어, Diff 형식
 - **라이선스:** apache-2.0
@@ -55,7 +55,7 @@ This model is fine-tuned from Meta's `codellama/CodeLlama-7b-hf` to review and p
 ## Uses / 사용 정보
 
 <details>
-<summary><strong>English</strong></summary>
+<summary><strong>🇺🇸 English</strong></summary>
 
 ### Direct Use
 
@@ -74,7 +74,7 @@ This model is specialized for code review tasks. It may not perform well for oth
 </details>
 
 <details>
-<summary><strong>한국어</strong></summary>
+<summary><strong>🇰🇷 한국어</strong></summary>
 
 ### 직접 사용
 
@@ -95,7 +95,7 @@ This model is specialized for code review tasks. It may not perform well for oth
 ## Bias, Risks, and Limitations / 편향, 위험 및 한계
 
 <details>
-<summary><strong>English</strong></summary>
+<summary><strong>🇺🇸 English</strong></summary>
 
 - **Data Bias:** The model was trained on public GitHub Pull Request data, so it may be biased towards specific coding styles or patterns present in that data.
 - **Inaccuracy (Hallucination):** The model may occasionally generate feedback that is factually incorrect or out of context. The generated reviews always need verification.
@@ -103,7 +103,7 @@ This model is specialized for code review tasks. It may not perform well for oth
 </details>
 
 <details>
-<summary><strong>한국어</strong></summary>
+<summary><strong>🇰🇷 한국어</strong></summary>
 
 - **데이터 편향:** 모델은 공개된 GitHub Pull Request 데이터를 기반으로 학습되었으므로, 해당 데이터에 존재하는 특정 코딩 스타일이나 패턴에 편향되어 있을 수 있습니다.
 - **부정확성(환각):** 모델은 때때로 사실과 다르거나 문맥에 맞지 않는 피드백을 생성할 수 있습니다. 생성된 리뷰는 항상 검증이 필요합니다.
@@ -113,19 +113,19 @@ This model is specialized for code review tasks. It may not perform well for oth
 ### Recommendations / 권장 사항
 
 <details>
-<summary><strong>English</strong></summary>
+<summary><strong>🇺🇸 English</strong></summary>
 Users should treat the code reviews generated by the model as a 'draft' or 'assistive tool' to help the development process, not as a final judgment. It is recommended that a human expert reviews critical changes.
 </details>
 
 <details>
-<summary><strong>한국어</strong></summary>
+<summary><strong>🇰🇷 한국어</strong></summary>
 사용자는 모델이 생성한 코드 리뷰를 최종적인 판단이 아닌, 개발 과정을 돕는 '초안' 또는 '보조 도구'로 활용해야 합니다. 중요한 변경사항에 대해서는 반드시 인간 전문가의 검토를 거치는 것을 권장합니다.
 </details>
 
 ## How to Get Started with the Model / 모델 시작하기
 
 <details>
-<summary><strong>English</strong></summary>
+<summary><strong>🇺🇸 English</strong></summary>
 
 **Note:** This model may be available in two versions: **Adapter** and **Merged**. Use the appropriate code for your model type.
 
@@ -140,15 +140,15 @@ If the model is fully merged with the base model, you can load it directly witho
 </details>
 
 <details>
-<summary><strong>한국어</strong></summary>
+<summary><strong>🇰🇷 한국어</strong></summary>
 
 **참고:** 이 모델은 **어댑터(Adapter)** 와 **병합된(Merged)** 두 가지 버전으로 제공될 수 있습니다. 자신의 모델 타입에 맞는 코드를 사용하세요.
 
-#### 1. 어댑터 모델 사용법 (`ken123777/codellama-7b-code-review-adapter`)
+#### 1. 어댑터 모델 사용법 (`ken12377/codellama-7b-code-review-adapter`)
 
 어댑터 모델을 사용하려면, 기반 모델을 먼저 로드한 후 `peft` 라이브러리를 사용해 어댑터를 적용해야 합니다.
 
-#### 2. 병합된 모델 사용법 (`ken123777/codellama-7b-code-review`)
+#### 2. 병합된 모델 사용법 (`ken12377/codellama-7b-code-review`)
 
 모델이 기반 모델과 완전히 병합된 경우, `peft` 없이 직접 모델을 로드하여 사용할 수 있습니다.
 
@@ -213,39 +213,42 @@ diff_code = """
 """
 
 # Prompt in Korean
+# 마크다운 파서의 혼동을 피하기 위해 코드 블록 구분자를 변수로 만들어 사용합니다.
+diff_block_delimiter = "```"
 prompt = f"""### 지시:
 제공된 코드는 pull request의 diff 내용입니다. 코드의 개선할 수 있는 부분에 대해 최소 3가지 항목으로 나누어 상세하고 구체적인 피드백을 제공해주세요.
 
 ### 입력:
-```diff
+{diff_block_delimiter}diff
 {diff_code}
-````
+{diff_block_delimiter}
 
 ### 응답:
-
 1. """
 
 inputs = tokenizer(prompt, return_tensors="pt").to(model.device)
-outputs = model.generate(\*\*inputs, max_new_tokens=512, temperature=0.7, repetition_penalty=1.2)
+outputs = model.generate(**inputs, max_new_tokens=512, temperature=0.7, repetition_penalty=1.2)
 response = tokenizer.decode(outputs[0]len(inputs.input_ids[0]):], skip_special_tokens=True)
 
 print(response)
 
-```
-
+````
 
 ## Training Details / 학습 상세 정보
 
 <details>
-<summary><strong>English</strong></summary>
+<summary><strong>🇺🇸 English</strong></summary>
 
 ### Training Data
+
 This model was fine-tuned using the `review_dataset.json` file, which contains public Pull Request data collected from GitHub. The dataset is structured in a `instruction`, `input`(diff), `output`(review comment) format.
 
 ### Training Procedure
+
 The model was fine-tuned using the QLoRA technique. It utilized the `SFTTrainer` from the `trl` library, applying 4-bit quantization and LoRA (Low-Rank Adaptation) for efficient training.
 
 #### Training Hyperparameters
+
 - **model:** `codellama/CodeLlama-7b-hf`
 - **max_seq_length:** 4096
 - **lora_alpha:** 128
@@ -260,15 +263,18 @@ The model was fine-tuned using the QLoRA technique. It utilized the `SFTTrainer`
 </details>
 
 <details>
-<summary><strong>한국어</strong></summary>
+<summary><strong>🇰🇷 한국어</strong></summary>
 
 ### 학습 데이터
+
 이 모델은 GitHub에서 수집된 공개 Pull Request 데이터를 포함하는 `review_dataset.json` 파일을 사용하여 파인튜닝되었습니다. 데이터셋은 `instruction`, `input`(diff), `output`(리뷰 코멘트) 형식으로 구성되어 있습니다.
 
 ### 학습 절차
+
 모델은 QLoRA 기법을 사용하여 파인튜닝되었습니다. `trl` 라이브러리의 `SFTTrainer`를 사용했으며, 4-bit 양자화와 LoRA(Low-Rank Adaptation)를 적용하여 효율적인 학습을 진행했습니다.
 
 #### 학습 하이퍼파라미터
+
 - **모델:** `codellama/CodeLlama-7b-hf`
 - **최대 시퀀스 길이:** 4096
 - **LoRA Alpha:** 128
@@ -285,16 +291,19 @@ The model was fine-tuned using the QLoRA technique. It utilized the `SFTTrainer`
 ## Compute Infrastructure / 컴퓨팅 인프라
 
 <details>
-<summary><strong>English</strong></summary>
+<summary><strong>🇺🇸 English</strong></summary>
 
 - **Hardware Type:** RunPod Cloud GPU
 - **Cloud Provider:** RunPod
 </details>
 
 <details>
-<summary><strong>한국어</strong></summary>
+<summary><strong>🇰🇷 한국어</strong></summary>
 
 - **하드웨어 종류:** RunPod 클라우드 GPU
 - **클라우드 제공업체:** RunPod
 </details>
-```
+
+```
+
+```