jalva182 commited on
Commit
be16f21
·
verified ·
1 Parent(s): 8f19933

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +90 -140
README.md CHANGED
@@ -1,9 +1,9 @@
1
  ---
2
- base_model: unsloth/llama-3-8b-instruct-bnb-4bit
3
  library_name: peft
4
  pipeline_tag: text-generation
5
  tags:
6
- - base_model:adapter:unsloth/llama-3-8b-instruct-bnb-4bit
7
  - grpo
8
  - lora
9
  - transformers
@@ -11,200 +11,150 @@ tags:
11
  - unsloth
12
  ---
13
 
14
- # Model Card for Model ID
15
-
16
- <!-- Provide a quick summary of what the model is/does. -->
17
-
18
 
 
19
 
20
  ## Model Details
21
 
22
  ### Model Description
23
 
24
- <!-- Provide a longer summary of what this model is. -->
25
-
26
-
 
 
27
 
28
- - **Developed by:** [More Information Needed]
29
- - **Funded by [optional]:** [More Information Needed]
30
- - **Shared by [optional]:** [More Information Needed]
31
- - **Model type:** [More Information Needed]
32
- - **Language(s) (NLP):** [More Information Needed]
33
- - **License:** [More Information Needed]
34
- - **Finetuned from model [optional]:** [More Information Needed]
35
 
36
- ### Model Sources [optional]
37
-
38
- <!-- Provide the basic links for the model. -->
39
-
40
- - **Repository:** [More Information Needed]
41
- - **Paper [optional]:** [More Information Needed]
42
- - **Demo [optional]:** [More Information Needed]
43
 
44
  ## Uses
45
 
46
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
47
-
48
  ### Direct Use
49
 
50
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
51
 
52
- [More Information Needed]
53
-
54
- ### Downstream Use [optional]
55
-
56
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
57
-
58
- [More Information Needed]
59
 
60
  ### Out-of-Scope Use
61
 
62
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
63
-
64
- [More Information Needed]
65
 
66
  ## Bias, Risks, and Limitations
67
 
68
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
69
-
70
- [More Information Needed]
71
-
72
- ### Recommendations
73
-
74
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
75
-
76
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
77
 
78
  ## How to Get Started with the Model
 
 
 
 
 
 
 
 
79
 
80
- Use the code below to get started with the model.
 
 
 
81
 
82
- [More Information Needed]
 
 
 
83
 
84
  ## Training Details
85
 
86
  ### Training Data
87
 
88
- <!-- 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. -->
89
-
90
- [More Information Needed]
91
-
92
- ### Training Procedure
93
-
94
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
95
-
96
- #### Preprocessing [optional]
97
-
98
- [More Information Needed]
99
 
 
100
 
101
- #### Training Hyperparameters
 
 
 
 
 
 
 
 
 
 
102
 
103
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
104
 
105
- #### Speeds, Sizes, Times [optional]
106
-
107
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
108
-
109
- [More Information Needed]
110
 
111
  ## Evaluation
112
 
113
- <!-- This section describes the evaluation protocols and provides the results. -->
114
-
115
- ### Testing Data, Factors & Metrics
116
-
117
- #### Testing Data
118
-
119
- <!-- This should link to a Dataset Card if possible. -->
120
-
121
- [More Information Needed]
122
 
123
- #### Factors
124
-
125
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
126
-
127
- [More Information Needed]
128
-
129
- #### Metrics
130
-
131
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
132
-
133
- [More Information Needed]
134
 
135
  ### Results
136
 
137
- [More Information Needed]
138
-
139
- #### Summary
140
-
141
 
 
142
 
143
- ## Model Examination [optional]
 
 
 
 
 
 
144
 
145
- <!-- Relevant interpretability work for the model goes here -->
146
-
147
- [More Information Needed]
148
 
149
  ## Environmental Impact
150
 
151
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
152
-
153
- 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).
154
-
155
- - **Hardware Type:** [More Information Needed]
156
- - **Hours used:** [More Information Needed]
157
- - **Cloud Provider:** [More Information Needed]
158
- - **Compute Region:** [More Information Needed]
159
- - **Carbon Emitted:** [More Information Needed]
160
-
161
- ## Technical Specifications [optional]
162
-
163
- ### Model Architecture and Objective
164
-
165
- [More Information Needed]
166
 
167
- ### Compute Infrastructure
168
 
169
- [More Information Needed]
170
 
171
- #### Hardware
 
 
172
 
173
- [More Information Needed]
174
 
175
- #### Software
 
 
 
 
176
 
177
- [More Information Needed]
178
 
179
- ## Citation [optional]
180
-
181
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
182
-
183
- **BibTeX:**
184
-
185
- [More Information Needed]
186
-
187
- **APA:**
188
-
189
- [More Information Needed]
190
-
191
- ## Glossary [optional]
192
-
193
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
194
-
195
- [More Information Needed]
196
-
197
- ## More Information [optional]
198
-
199
- [More Information Needed]
200
-
201
- ## Model Card Authors [optional]
202
-
203
- [More Information Needed]
204
 
205
  ## Model Card Contact
206
 
207
- [More Information Needed]
 
208
  ### Framework versions
209
 
210
  - PEFT 0.18.1
 
1
  ---
2
+ base_model: unsloth/llama-3-8b-Instruct
3
  library_name: peft
4
  pipeline_tag: text-generation
5
  tags:
6
+ - base_model:adapter:unsloth/llama-3-8b-Instruct
7
  - grpo
8
  - lora
9
  - transformers
 
11
  - unsloth
12
  ---
13
 
14
+ # CLI Agent Llama 3 8B GRPO Fine-tune (GPU 1 / lr=5e-6)
 
 
 
15
 
16
+ A LoRA adapter fine-tuned on Meta-Llama-3-8B-Instruct using GRPO (Group Relative Policy Optimization) to generate correct Linux shell commands from natural language task descriptions. This is the GPU 1 run trained at lr=5e-6. See also [jalva182/cli-agent-model](https://huggingface.co/jalva182/cli-agent-model) for the GPU 0 run at lr=3e-6.
17
 
18
  ## Model Details
19
 
20
  ### Model Description
21
 
22
+ - **Developed by:** Jose Alvarez, Carson Chiem, Prisha Bhattacharyya, Vishal Tyagi
23
+ - **Model type:** Causal Language Model (LoRA adapter)
24
+ - **Language(s) (NLP):** English
25
+ - **License:** Meta Llama 3 Community License
26
+ - **Finetuned from model:** unsloth/llama-3-8b-Instruct
27
 
28
+ ### Model Sources
 
 
 
 
 
 
29
 
30
+ - **Repository:** https://github.com/Alvarez-Jose/unsloth-grpo-project
 
 
 
 
 
 
31
 
32
  ## Uses
33
 
 
 
34
  ### Direct Use
35
 
36
+ Given a natural language description of a CLI task, the model outputs the correct shell command with no explanation, no markdown, and no backticks.
37
 
38
+ Example:
39
+ - Input: "Count the number of lines in /tmp/data/log.txt"
40
+ - Output: `wc -l /tmp/data/log.txt`
 
 
 
 
41
 
42
  ### Out-of-Scope Use
43
 
44
+ - Not intended for general conversation
45
+ - Not suitable for tasks outside Linux CLI command generation
46
+ - Should not be used for destructive or malicious shell commands
47
 
48
  ## Bias, Risks, and Limitations
49
 
50
+ - Model may generate incorrect or harmful shell commands always review before executing
51
+ - Trained on a limited set of ~60 task types, may not generalize to all CLI scenarios
52
+ - Performance degrades on complex multi-step tasks
 
 
 
 
 
 
53
 
54
  ## How to Get Started with the Model
55
+ ```python
56
+ from unsloth import FastLanguageModel
57
+
58
+ model, tokenizer = FastLanguageModel.from_pretrained(
59
+ model_name="jalva182/cli-agent-model-gpu1",
60
+ max_seq_length=512,
61
+ load_in_4bit=True,
62
+ )
63
 
64
+ messages = [
65
+ {"role": "system", "content": "You are a CLI expert. Given a task, output exactly the shell commands required. No explanation, no markdown, no backticks."},
66
+ {"role": "user", "content": "Count the number of lines in /tmp/data/log.txt"},
67
+ ]
68
 
69
+ inputs = tokenizer.apply_chat_template(messages, return_tensors="pt").to("cuda")
70
+ outputs = model.generate(input_ids=inputs, max_new_tokens=64)
71
+ print(tokenizer.decode(outputs[0], skip_special_tokens=True))
72
+ ```
73
 
74
  ## Training Details
75
 
76
  ### Training Data
77
 
78
+ 60 validated CLI tasks covering file operations, text processing (grep, awk, sed), sorting, archives, system info, permissions, and environment variables. Each task includes setup commands, expected output, and a reward function for GRPO training.
 
 
 
 
 
 
 
 
 
 
79
 
80
+ ### Training Hyperparameters
81
 
82
+ - **Training regime:** bf16 mixed precision
83
+ - **Method:** GRPO (Group Relative Policy Optimization)
84
+ - **Learning rate:** 5e-6 with linear scheduler
85
+ - **Warmup ratio:** 0.1
86
+ - **Batch size:** 2 (per device)
87
+ - **Gradient accumulation steps:** 2
88
+ - **Total steps:** 10000
89
+ - **LoRA rank:** 32, alpha: 64
90
+ - **KL coefficient:** 0.05
91
+ - **Number of generations:** 4
92
+ - **Max sequence length:** 512
93
 
94
+ ### Speeds, Sizes, Times
95
 
96
+ - **Training time:** ~4h 7min
97
+ - **Checkpoint size:** ~524MB (LoRA adapter only)
98
+ - **Final train loss:** 0.0188
99
+ - **Final reward:** 8.0/8.0 on final steps
 
100
 
101
  ## Evaluation
102
 
103
+ ### Metrics
 
 
 
 
 
 
 
 
104
 
105
+ Reward function scoring 0-8 per task:
106
+ - +5 for correct output match
107
+ - +3 for command success with partial match
108
+ - -2 for command failure or wrong output
 
 
 
 
 
 
 
109
 
110
  ### Results
111
 
112
+ - **Best reward:** 8.0
113
+ - **Average reward (final steps):** ~6.0
114
+ - **Train loss:** 0.0188
 
115
 
116
+ ## Comparison with GPU 0 Run
117
 
118
+ | | GPU 0 (cli-agent-model) | GPU 1 (cli-agent-model-gpu1) |
119
+ |---|---|---|
120
+ | Learning rate | 3e-6 | 5e-6 |
121
+ | Train loss | 0.0141 | 0.0188 |
122
+ | Final reward | 8.0 | 8.0 |
123
+ | Runtime | 3h 13min | 4h 7min |
124
+ | Recommendation | ✅ Primary | Secondary |
125
 
126
+ GPU 0 achieved lower train loss and is recommended as the primary model.
 
 
127
 
128
  ## Environmental Impact
129
 
130
+ - **Hardware Type:** H100 SXM 80GB
131
+ - **Hours used:** ~4.5 hours
132
+ - **Cloud Provider:** Vast.ai
 
 
 
 
 
 
 
 
 
 
 
 
133
 
134
+ ## Technical Specifications
135
 
136
+ ### Model Architecture
137
 
138
+ - Base: Meta-Llama-3-8B-Instruct
139
+ - Adapter: LoRA (rank=32, alpha=64, dropout=0.05)
140
+ - Target modules: q_proj, k_proj, v_proj, o_proj, gate_proj, up_proj, down_proj
141
 
142
+ ### Software
143
 
144
+ - unsloth 2026.3.3
145
+ - trl 0.24.0
146
+ - transformers 4.56.1
147
+ - torch 2.6.0+cu124
148
+ - PEFT 0.18.1
149
 
150
+ ## Model Card Authors
151
 
152
+ Jose Alvarez
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
153
 
154
  ## Model Card Contact
155
 
156
+ https://github.com/Alvarez-Jose/unsloth-grpo-project
157
+
158
  ### Framework versions
159
 
160
  - PEFT 0.18.1