jalva182 commited on
Commit
8ce7dc8
·
verified ·
1 Parent(s): 7018a70

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +96 -155
README.md CHANGED
@@ -1,210 +1,151 @@
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
10
- - trl
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
10
+ - trl
11
+ - unsloth
12
+ license: apache-2.0
13
+ language:
14
+ - en
15
+ ---
16
+
17
+ # CLI Agent — Llama 3 8B GRPO Fine-tune
18
+
19
+ 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.
20
 
21
  ## Model Details
22
 
23
  ### Model Description
24
 
25
+ - **Developed by:** Jose Alvarez, Carson Chiem, Prisha Bhattacharyya, Vishal Tyagi
26
+ - **Model type:** Causal Language Model (LoRA adapter)
27
+ - **Language(s) (NLP):** English
28
+ - **License:** Meta Llama 3 Community License
29
+ - **Finetuned from model:** unsloth/llama-3-8b-Instruct
 
 
 
 
 
 
 
 
30
 
31
+ ### Model Sources
32
 
33
+ - **Repository:** https://github.com/Alvarez-Jose/unsloth-grpo-project
 
 
34
 
35
  ## Uses
36
 
 
 
37
  ### Direct Use
38
 
39
+ Given a natural language description of a CLI task, the model outputs the correct shell command with no explanation, no markdown, and no backticks.
 
 
 
 
 
 
40
 
41
+ Example:
42
+ - Input: "Count the number of lines in /tmp/data/log.txt"
43
+ - Output: `wc -l /tmp/data/log.txt`
44
 
45
  ### Out-of-Scope Use
46
 
47
+ - Not intended for general conversation
48
+ - Not suitable for tasks outside Linux CLI command generation
49
+ - Should not be used for destructive or malicious shell commands
50
 
51
  ## Bias, Risks, and Limitations
52
 
53
+ - Model may generate incorrect or harmful shell commands always review before executing
54
+ - Trained on a limited set of ~60 task types, may not generalize to all CLI scenarios
55
+ - Performance degrades on complex multi-step tasks
 
 
 
 
 
 
56
 
57
  ## How to Get Started with the Model
58
+ ```python
59
+ from unsloth import FastLanguageModel
60
 
61
+ model, tokenizer = FastLanguageModel.from_pretrained(
62
+ model_name="jalva182/cli-agent-model",
63
+ max_seq_length=512,
64
+ load_in_4bit=True,
65
+ )
66
 
67
+ messages = [
68
+ {"role": "system", "content": "You are a CLI expert. Given a task, output exactly the shell commands required. No explanation, no markdown, no backticks."},
69
+ {"role": "user", "content": "Count the number of lines in /tmp/data/log.txt"},
70
+ ]
71
+
72
+ inputs = tokenizer.apply_chat_template(messages, return_tensors="pt").to("cuda")
73
+ outputs = model.generate(input_ids=inputs, max_new_tokens=64)
74
+ print(tokenizer.decode(outputs[0], skip_special_tokens=True))
75
+ ```
76
 
77
  ## Training Details
78
 
79
  ### Training Data
80
 
81
+ 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.
 
 
 
 
 
 
 
 
82
 
83
+ ### Training Hyperparameters
84
 
85
+ - **Training regime:** bf16 mixed precision
86
+ - **Method:** GRPO (Group Relative Policy Optimization)
87
+ - **Learning rate:** 3e-6 with linear scheduler
88
+ - **Warmup ratio:** 0.1
89
+ - **Batch size:** 2 (per device)
90
+ - **Gradient accumulation steps:** 2
91
+ - **Total steps:** 10000
92
+ - **LoRA rank:** 32, alpha: 64
93
+ - **KL coefficient:** 0.05
94
+ - **Number of generations:** 4
95
+ - **Max sequence length:** 512
96
 
97
+ ### Speeds, Sizes, Times
98
 
99
+ - **Training time:** ~3h 13min
100
+ - **Checkpoint size:** ~524MB (LoRA adapter only)
101
+ - **Final train loss:** 0.0141
102
+ - **Final reward:** 8.0/8.0 on easy tasks, ~6.0 average
 
 
 
103
 
104
  ## Evaluation
105
 
106
+ ### Metrics
 
 
 
 
 
 
 
 
107
 
108
+ Reward function scoring 0-8 per task:
109
+ - +5 for correct output match
110
+ - +3 for command success with partial match
111
+ - -2 for command failure or wrong output
 
 
 
 
 
 
 
112
 
113
  ### Results
114
 
115
+ - **Best reward:** 8.0
116
+ - **Average reward (final steps):** ~6.0
117
+ - **Train loss:** 0.0141
 
 
 
 
 
 
 
 
118
 
119
  ## Environmental Impact
120
 
121
+ - **Hardware Type:** H100 SXM 80GB
122
+ - **Hours used:** ~3.5 hours
123
+ - **Cloud Provider:** Vast.ai
 
 
 
 
 
 
 
 
 
 
124
 
125
+ ## Technical Specifications
126
 
127
+ ### Model Architecture
128
 
129
+ - Base: Meta-Llama-3-8B-Instruct
130
+ - Adapter: LoRA (rank=32, alpha=64, dropout=0.05)
131
+ - Target modules: q_proj, k_proj, v_proj, o_proj, gate_proj, up_proj, down_proj
132
 
133
+ ### Software
134
 
135
+ - unsloth 2026.3.3
136
+ - trl 0.24.0
137
+ - transformers 4.56.1
138
+ - torch 2.6.0+cu124
139
+ - PEFT 0.18.1
140
 
141
+ ## Model Card Authors
142
 
143
+ Jose Alvarez
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
144
 
145
  ## Model Card Contact
146
 
147
+ https://github.com/Alvarez-Jose/unsloth-grpo-project
148
+
149
  ### Framework versions
150
 
151
  - PEFT 0.18.1