Update README.md

README.md

@@ -11,7 +11,7 @@ base_model:
 
 ## Model Overview
 
-This model has been fine-tuned on the `swe_bench` dataset to automate the generation of bug fixes in software engineering tasks. It leverages issue descriptions, code diffs, and historical bug context to generate precise patches. The primary use case is to assist developers by quickly generating code fixes based on detailed bug descriptions.
+This model has been fine-tuned on the `princeton-nlp/SWE-bench_Lite` dataset to automate the generation of bug fixes in software engineering tasks. It leverages issue descriptions, code diffs, and historical bug context to generate precise patches. The primary use case is to assist developers by quickly generating code fixes based on detailed bug descriptions.
 
 ### Key Features:
 - **Patch Generation**: Produces code patches based on issue descriptions and optional context.
@@ -23,11 +23,11 @@ This model has been fine-tuned on the `swe_bench` dataset to automate the genera
 The model is designed for developers and software teams to automatically generate code patches for software issues. It can handle a variety of inputs such as issue descriptions and additional context and is ideal for teams dealing with frequent bug reports.
 
 ### Inputs:
-1. **Issue Description (<issue>)**: Main input, taken from `fix_issue_description`.
-2. **Issue Story (<fix_issue_story>)**: Optional additional context, from `fix_story`.
-3. **Assertions (<assertions>)**: Conditions that the patch must meet, from `fix_assertion_1`, `fix_assertion_2`, etc.
-4. **Bug and PR Context (<bug>)**: Historical bug and PR context from fields like `bug_pr`, `bug_story`, etc., used during fine-tuning but not required for inference.
-5. **File Paths and Code Differences (<file>, <bug_code_diff>, <fix_code_diff>)**: Paths and diffs used to generate a valid code patch.
+1. **Issue Description (`<issue>`)**: Main input, taken from `fix_issue_description`.
+2. **Issue Story (`<fix_issue_story>`)**: Optional additional context, from `fix_story`.
+3. **Assertions (`<assertions>`)**: Conditions that the patch must meet, from `fix_assertion_1`, `fix_assertion_2`, etc.
+4. **Bug and PR Context (`<bug>`)**: Historical bug and PR context from fields like `bug_pr`, `bug_story`, etc., used during fine-tuning but not required for inference.
+5. **File Paths and Code Differences (`<file>`, `<bug_code_diff>`, `<fix_code_diff>`)**: Paths and diffs used to generate a valid code patch.
 
 ### Outputs:
 - **Generated Code Patch**: Based on input issue description and additional context.
@@ -35,7 +35,8 @@ The model is designed for developers and software teams to automatically generat
 
 ## Dataset
 
-### Dataset: `swe_bench-lite`
+### Dataset: `princeton-nlp/SWE-bench_Lite`
+
 This model is fine-tuned on the `swe_bench` dataset. The dataset includes:
 - **<issue> (Issue Description)**: Describes the bug in detail.
 - **<fix_issue_story> (Issue Story)**: Provides additional narrative or context around the bug.
@@ -43,6 +44,7 @@ This model is fine-tuned on the `swe_bench` dataset. The dataset includes:
 - **<bug> (Bug and PR Context)**: Provides historical context on bugs, used in fine-tuning.
 - **<file>, <bug_code_diff>, <fix_code_diff>**: File paths and code diffs used to train the model to generate fixes.
 
+
 ## Limitations
 
 - The model relies on well-defined issue descriptions to produce accurate patches.
@@ -69,17 +71,4 @@ print(tokenizer.decode(outputs[0]))
 ## Ethical Considerations
 
 - The generated patches should always be validated and reviewed by developers before deploying in production.
-- This model is designed to assist but should not replace thorough code reviews.
-
-## Citation
-
-Please cite this model as follows:
-
-```
-@inproceedings{tandon_ft_llama3_1_swe_bench,
-  title={Automatic Bug Fix Generation using Llama-3.1 and SWE Bench Dataset},
-  author={Gauransh Tandon, Caroline Lemiuex, and Reid Holmes},
-  year={2024},
-  publisher={Hugging Face}
-}
-```
+- This model is designed to assist but should not replace thorough code reviews.