czlll nielsr HF Staff commited on
Commit
7fa0a2b
·
verified ·
1 Parent(s): 2dede47

Improve model card (#1)

Browse files

- Improve model card (a0e11a3a93e3cc79fd1bca4cc26b21f5ea73acec)


Co-authored-by: Niels Rogge <[email protected]>

Files changed (1) hide show
  1. README.md +47 -194
README.md CHANGED
@@ -1,200 +1,53 @@
1
  ---
2
  library_name: transformers
 
3
  tags:
4
  - unsloth
5
  ---
6
 
7
- # Model Card for Model ID
8
-
9
- <!-- Provide a quick summary of what the model is/does. -->
10
-
11
-
12
-
13
- ## Model Details
14
-
15
- ### Model Description
16
-
17
- <!-- Provide a longer summary of what this model is. -->
18
-
19
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
20
-
21
- - **Developed by:** [More Information Needed]
22
- - **Funded by [optional]:** [More Information Needed]
23
- - **Shared by [optional]:** [More Information Needed]
24
- - **Model type:** [More Information Needed]
25
- - **Language(s) (NLP):** [More Information Needed]
26
- - **License:** [More Information Needed]
27
- - **Finetuned from model [optional]:** [More Information Needed]
28
-
29
- ### Model Sources [optional]
30
-
31
- <!-- Provide the basic links for the model. -->
32
-
33
- - **Repository:** [More Information Needed]
34
- - **Paper [optional]:** [More Information Needed]
35
- - **Demo [optional]:** [More Information Needed]
36
-
37
- ## Uses
38
-
39
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
40
-
41
- ### Direct Use
42
-
43
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
44
-
45
- [More Information Needed]
46
-
47
- ### Downstream Use [optional]
48
-
49
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
50
-
51
- [More Information Needed]
52
-
53
- ### Out-of-Scope Use
54
-
55
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
56
-
57
- [More Information Needed]
58
-
59
- ## Bias, Risks, and Limitations
60
-
61
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
62
-
63
- [More Information Needed]
64
-
65
- ### Recommendations
66
-
67
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
68
-
69
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
70
-
71
- ## How to Get Started with the Model
72
-
73
- Use the code below to get started with the model.
74
-
75
- [More Information Needed]
76
-
77
- ## Training Details
78
-
79
- ### Training Data
80
-
81
- <!-- 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. -->
82
-
83
- [More Information Needed]
84
-
85
- ### Training Procedure
86
-
87
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
88
-
89
- #### Preprocessing [optional]
90
-
91
- [More Information Needed]
92
-
93
-
94
- #### Training Hyperparameters
95
-
96
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
97
-
98
- #### Speeds, Sizes, Times [optional]
99
-
100
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
101
-
102
- [More Information Needed]
103
-
104
- ## Evaluation
105
-
106
- <!-- This section describes the evaluation protocols and provides the results. -->
107
-
108
- ### Testing Data, Factors & Metrics
109
-
110
- #### Testing Data
111
-
112
- <!-- This should link to a Dataset Card if possible. -->
113
-
114
- [More Information Needed]
115
-
116
- #### Factors
117
-
118
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
119
-
120
- [More Information Needed]
121
-
122
- #### Metrics
123
-
124
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
125
-
126
- [More Information Needed]
127
-
128
- ### Results
129
-
130
- [More Information Needed]
131
-
132
- #### Summary
133
-
134
-
135
-
136
- ## Model Examination [optional]
137
-
138
- <!-- Relevant interpretability work for the model goes here -->
139
-
140
- [More Information Needed]
141
-
142
- ## Environmental Impact
143
-
144
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
145
-
146
- 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).
147
-
148
- - **Hardware Type:** [More Information Needed]
149
- - **Hours used:** [More Information Needed]
150
- - **Cloud Provider:** [More Information Needed]
151
- - **Compute Region:** [More Information Needed]
152
- - **Carbon Emitted:** [More Information Needed]
153
-
154
- ## Technical Specifications [optional]
155
-
156
- ### Model Architecture and Objective
157
-
158
- [More Information Needed]
159
-
160
- ### Compute Infrastructure
161
-
162
- [More Information Needed]
163
-
164
- #### Hardware
165
-
166
- [More Information Needed]
167
-
168
- #### Software
169
-
170
- [More Information Needed]
171
-
172
- ## Citation [optional]
173
-
174
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
175
-
176
- **BibTeX:**
177
-
178
- [More Information Needed]
179
-
180
- **APA:**
181
-
182
- [More Information Needed]
183
-
184
- ## Glossary [optional]
185
-
186
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
187
-
188
- [More Information Needed]
189
-
190
- ## More Information [optional]
191
-
192
- [More Information Needed]
193
-
194
- ## Model Card Authors [optional]
195
-
196
- [More Information Needed]
197
-
198
- ## Model Card Contact
199
-
200
- [More Information Needed]
 
1
  ---
2
  library_name: transformers
3
+ pipeline_tag: text-generation
4
  tags:
5
  - unsloth
6
  ---
7
 
8
+ # Model Card for LocAgent
9
+
10
+ This model is described in the paper [LocAgent: Graph-Guided LLM Agents for Code Localization](https://huggingface.co/papers/2503.09089). LocAgent uses a graph-based code representation to enable LLMs to perform accurate code localization, significantly improving accuracy compared to existing methods. Notably, the fine-tuned Qwen-2.5-Coder-Instruct-32B model achieves near state-of-the-art performance with a substantial cost reduction.
11
+
12
+ Code: https://github.com/gersteinlab/LocAgent
13
+
14
+ ## How to Use
15
+
16
+ LocAgent involves two main steps: graph indexing and code localization.
17
+
18
+ **1. Graph Indexing (Optional but Recommended):** For efficient batch processing, pre-generate graph indexes for your codebase using `dependency_graph/batch_build_graph.py`. This script parses the codebase into a graph representation. See the Github README for detailed command-line arguments and setup instructions. Example:
19
+ ```bash
20
+ python dependency_graph/batch_build_graph.py \
21
+ --dataset 'czlll/Loc-Bench' \
22
+ --split 'test' \
23
+ --num_processes 50 \
24
+ --download_repo
25
+ ```
26
+
27
+ **2. Code Localization:** Use `auto_search_main.py` to perform code localization. This script leverages LLMs to search and locate relevant code entities within the pre-generated graph indexes. See the Github README for detailed command-line arguments and environment variable setup. Example:
28
+ ```bash
29
+ python auto_search_main.py \
30
+ --dataset 'czlll/SWE-bench_Lite' \
31
+ --split 'test' \
32
+ --model 'azure/gpt-4o' \
33
+ --localize \
34
+ --merge \
35
+ --output_folder $result_path/location \
36
+ --eval_n_limit 300 \
37
+ --num_processes 50 \
38
+ --use_function_calling \
39
+ --simple_desc
40
+ ```
41
+
42
+ **3. Evaluation:** After localization, evaluate the results using `evaluation.eval_metric.evaluate_results`. An example Jupyter Notebook is provided in `evaluation/run_evaluation.ipynb`.
43
+
44
+ ## Citation
45
+
46
+ ```bibtex
47
+ @article{chen2025locagent,
48
+ title={LocAgent: Graph-Guided LLM Agents for Code Localization},
49
+ author={Chen, Zhaoling and Tang, Xiangru and Deng, Gangda and Wu, Fang and Wu, Jialong and Jiang, Zhiwei and Prasanna, Viktor and Cohan, Arman and Wang, Xingyao},
50
+ journal={arXiv preprint arXiv:2503.09089},
51
+ year={2025}
52
+ }
53
+ ```