jhsu12 commited on
Commit
413b483
·
verified ·
1 Parent(s): 087a3b4

Add model card for Access Control

Browse files
Files changed (1) hide show
  1. README.md +77 -197
README.md CHANGED
@@ -1,206 +1,86 @@
1
  ---
2
- base_model: Qwen/Qwen2.5-Coder-3B-Instruct
3
  library_name: peft
 
4
  tags:
5
- - base_model:adapter:Qwen/Qwen2.5-Coder-3B-Instruct
6
- - lora
7
- - transformers
 
 
 
 
 
 
8
  ---
9
 
10
- # Model Card for Model ID
11
-
12
- <!-- Provide a quick summary of what the model is/does. -->
13
-
14
 
 
15
 
16
  ## Model Details
17
 
18
- ### Model Description
19
-
20
- <!-- Provide a longer summary of what this model is. -->
21
-
22
-
23
-
24
- - **Developed by:** [More Information Needed]
25
- - **Funded by [optional]:** [More Information Needed]
26
- - **Shared by [optional]:** [More Information Needed]
27
- - **Model type:** [More Information Needed]
28
- - **Language(s) (NLP):** [More Information Needed]
29
- - **License:** [More Information Needed]
30
- - **Finetuned from model [optional]:** [More Information Needed]
31
-
32
- ### Model Sources [optional]
33
-
34
- <!-- Provide the basic links for the model. -->
35
-
36
- - **Repository:** [More Information Needed]
37
- - **Paper [optional]:** [More Information Needed]
38
- - **Demo [optional]:** [More Information Needed]
39
-
40
- ## Uses
41
-
42
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
43
-
44
- ### Direct Use
45
-
46
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
47
-
48
- [More Information Needed]
49
-
50
- ### Downstream Use [optional]
51
-
52
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
53
-
54
- [More Information Needed]
55
-
56
- ### Out-of-Scope Use
57
-
58
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
59
-
60
- [More Information Needed]
61
-
62
- ## Bias, Risks, and Limitations
63
-
64
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
65
-
66
- [More Information Needed]
67
-
68
- ### Recommendations
69
-
70
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
71
-
72
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
73
-
74
- ## How to Get Started with the Model
75
-
76
- Use the code below to get started with the model.
77
-
78
- [More Information Needed]
79
-
80
- ## Training Details
81
-
82
- ### Training Data
83
-
84
- <!-- 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. -->
85
-
86
- [More Information Needed]
87
-
88
- ### Training Procedure
89
-
90
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
91
-
92
- #### Preprocessing [optional]
93
-
94
- [More Information Needed]
95
-
96
-
97
- #### Training Hyperparameters
98
-
99
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
100
-
101
- #### Speeds, Sizes, Times [optional]
102
-
103
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
104
-
105
- [More Information Needed]
106
-
107
- ## Evaluation
108
-
109
- <!-- This section describes the evaluation protocols and provides the results. -->
110
-
111
- ### Testing Data, Factors & Metrics
112
-
113
- #### Testing Data
114
-
115
- <!-- This should link to a Dataset Card if possible. -->
116
-
117
- [More Information Needed]
118
-
119
- #### Factors
120
-
121
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
122
-
123
- [More Information Needed]
124
-
125
- #### Metrics
126
-
127
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
128
-
129
- [More Information Needed]
130
-
131
- ### Results
132
-
133
- [More Information Needed]
134
-
135
- #### Summary
136
-
137
-
138
-
139
- ## Model Examination [optional]
140
-
141
- <!-- Relevant interpretability work for the model goes here -->
142
-
143
- [More Information Needed]
144
-
145
- ## Environmental Impact
146
-
147
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
148
-
149
- 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).
150
-
151
- - **Hardware Type:** [More Information Needed]
152
- - **Hours used:** [More Information Needed]
153
- - **Cloud Provider:** [More Information Needed]
154
- - **Compute Region:** [More Information Needed]
155
- - **Carbon Emitted:** [More Information Needed]
156
-
157
- ## Technical Specifications [optional]
158
-
159
- ### Model Architecture and Objective
160
-
161
- [More Information Needed]
162
-
163
- ### Compute Infrastructure
164
-
165
- [More Information Needed]
166
-
167
- #### Hardware
168
-
169
- [More Information Needed]
170
-
171
- #### Software
172
-
173
- [More Information Needed]
174
-
175
- ## Citation [optional]
176
-
177
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
178
-
179
- **BibTeX:**
180
-
181
- [More Information Needed]
182
-
183
- **APA:**
184
-
185
- [More Information Needed]
186
-
187
- ## Glossary [optional]
188
-
189
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
190
-
191
- [More Information Needed]
192
-
193
- ## More Information [optional]
194
-
195
- [More Information Needed]
196
-
197
- ## Model Card Authors [optional]
198
-
199
- [More Information Needed]
200
-
201
- ## Model Card Contact
202
-
203
- [More Information Needed]
204
- ### Framework versions
205
-
206
- - PEFT 0.18.1
 
1
  ---
 
2
  library_name: peft
3
+ base_model: Qwen/Qwen2.5-Coder-3B-Instruct
4
  tags:
5
+ - peft
6
+ - lora
7
+ - sequence-classification
8
+ - solidity
9
+ - smart-contract
10
+ - vulnerability-detection
11
+ - access-control
12
+ pipeline_tag: text-classification
13
+ license: apache-2.0
14
  ---
15
 
16
+ # Solidity Vulnerability Classifier Access Control
 
 
 
17
 
18
+ Binary classifier that detects **Access Control** vulnerabilities in Solidity smart contracts.
19
 
20
  ## Model Details
21
 
22
+ - **Base model**: [Qwen/Qwen2.5-Coder-3B-Instruct](https://huggingface.co/Qwen/Qwen2.5-Coder-3B-Instruct)
23
+ - **Method**: QLoRA (4-bit NF4) + classification head
24
+ - **Task**: Sequence Classification (2 labels: safe / vulnerable)
25
+ - **LoRA rank**: 16, targeting q_proj, k_proj, v_proj, o_proj
26
+ - **Classification head**: `modules_to_save=["score"]`
27
+
28
+ ## Available Checkpoints
29
+
30
+ Load a specific checkpoint with `revision=`:
31
+ ```python
32
+ model = PeftModel.from_pretrained(base, "jhsu12/solidity-vuln-cls-access-control-v1", revision="checkpoint-200")
33
+ ```
34
+
35
+ | Tag | Step |
36
+ |-----|------|
37
+ | `checkpoint-28` | 28 |
38
+ | `checkpoint-56` | 56 |
39
+ | `checkpoint-84` | 84 |
40
+ | `checkpoint-112` | 112 |
41
+ | `checkpoint-140` | 140 `main` |
42
+
43
+ ## Usage
44
+
45
+ ```python
46
+ from transformers import AutoTokenizer, AutoModelForSequenceClassification, BitsAndBytesConfig
47
+ from peft import PeftModel
48
+ import torch
49
+
50
+ base_model = "Qwen/Qwen2.5-Coder-3B-Instruct"
51
+ bnb_config = BitsAndBytesConfig(load_in_4bit=True, bnb_4bit_quant_type="nf4",
52
+ bnb_4bit_compute_dtype=torch.bfloat16, bnb_4bit_use_double_quant=True)
53
+
54
+ model = AutoModelForSequenceClassification.from_pretrained(
55
+ base_model, num_labels=2, quantization_config=bnb_config,
56
+ device_map="auto", trust_remote_code=True, ignore_mismatched_sizes=True)
57
+ model = PeftModel.from_pretrained(model, "jhsu12/solidity-vuln-cls-access-control-v1")
58
+ model.eval()
59
+
60
+ tokenizer = AutoTokenizer.from_pretrained("jhsu12/solidity-vuln-cls-access-control-v1", trust_remote_code=True)
61
+
62
+ code = "pragma solidity ^0.8.0; contract Example { ... }"
63
+ inputs = tokenizer(code, return_tensors="pt", truncation=True, max_length=1536).to(model.device)
64
+ with torch.no_grad():
65
+ logits = model(**inputs).logits
66
+ probs = torch.softmax(logits, dim=-1)
67
+ print(f"Safe: {probs[0][0]:.2%}, Vulnerable: {probs[0][1]:.2%}")
68
+ ```
69
+
70
+ Or use the inference script:
71
+ ```bash
72
+ python inference_classifier.py --checkpoint jhsu12/solidity-vuln-cls-access-control-v1 --file contract.sol
73
+ ```
74
+
75
+ ## Part of
76
+
77
+ This is one of 5 expert classifiers in the
78
+ [Solidity Vulnerability Detector](https://huggingface.co/jhsu12/solidity-vulnerability-detector) system.
79
+
80
+ | Expert | Hub Repo |
81
+ |--------|----------|
82
+ | Reentrancy | `jhsu12/solidity-vuln-cls-reentrancy-v1` |
83
+ | Access Control | `jhsu12/solidity-vuln-cls-access-control-v1` |
84
+ | Integer Overflow/Underflow | `jhsu12/solidity-vuln-cls-integer-overflow-underflow-v1` |
85
+ | Timestamp Dependence | `jhsu12/solidity-vuln-cls-timestamp-dependence-v1` |
86
+ | Unchecked Low-Level Calls | `jhsu12/solidity-vuln-cls-unchecked-low-level-calls-v1` |