Update README.md
Browse files
README.md
CHANGED
@@ -1,5 +1,5 @@
|
|
1 |
---
|
2 |
-
base_model: unsloth/Llama-3.2-
|
3 |
tags:
|
4 |
- text-generation-inference
|
5 |
- transformers
|
@@ -21,8 +21,13 @@ language:
|
|
21 |
- **Model type:** GGUF (compatible with Ollama)
|
22 |
- **Language:** English
|
23 |
|
24 |
-
This Llama-based model was fine-tuned to
|
25 |
|
|
|
|
|
|
|
|
|
|
|
26 |
---
|
27 |
|
28 |
## How to Use the Model
|
@@ -138,62 +143,17 @@ The model assists users by:
|
|
138 |
- **Fine-tuning:** Leveraged the Unsloth framework and Hugging Face's TRL library for efficient training.
|
139 |
- **Training Data:** Customized dataset focused on Kubernetes operations and `kubectl` command usage, containing approximately 200 entries.
|
140 |
|
141 |
-
### Features
|
142 |
-
|
143 |
-
- **Command Generation:** Translates user instructions into executable `kubectl` commands.
|
144 |
-
- **Clarification Requests:** Politely asks for more details when the instruction is incomplete.
|
145 |
-
- **Knowledge Base:** Provides concise explanations for general Kubernetes concepts.
|
146 |
-
|
147 |
---
|
148 |
|
149 |
-
##
|
150 |
-
|
151 |
-
The model uses the following prompt template to generate responses:
|
152 |
-
|
153 |
-
```plaintext
|
154 |
-
You are an AI assistant that helps users with Kubernetes commands and questions.
|
155 |
-
|
156 |
-
**Your Behavior Guidelines:**
|
157 |
-
|
158 |
-
1. **For clear and complete instructions:**
|
159 |
-
- **Provide only** the exact `kubectl` command needed to fulfill the user's request.
|
160 |
-
- Do not include extra explanations, placeholders, or context.
|
161 |
-
- **Enclose the command within a code block** with `bash` syntax highlighting.
|
162 |
-
|
163 |
-
2. **For incomplete or ambiguous instructions:**
|
164 |
-
- **Politely ask** the user for the specific missing information.
|
165 |
-
- Do **not** provide any commands or placeholders in your response.
|
166 |
-
- Respond in plain text, clearly stating what information is needed.
|
167 |
|
168 |
-
|
169 |
-
- Provide a **concise and accurate explanation**.
|
170 |
-
- Do **not** include any commands unless specifically requested.
|
171 |
-
- Ensure that the explanation fully addresses the user's question.
|
172 |
|
173 |
-
|
174 |
-
|
175 |
-
- **Do not generate CLI commands containing placeholders (e.g., <pod_name>, <resource_name>).**
|
176 |
-
- Ensure all CLI commands are complete, valid, and executable as provided.
|
177 |
-
- If user input is insufficient to form a complete command, ask for clarification instead of using placeholders.
|
178 |
-
- Provide only the necessary CLI command output without any additional text.
|
179 |
-
|
180 |
-
### Instruction:
|
181 |
-
{instruction}
|
182 |
-
|
183 |
-
### Response:
|
184 |
-
{response}
|
185 |
-
```
|
186 |
-
|
187 |
-
### Parameters
|
188 |
-
|
189 |
-
- **Temperature:** `0.3` (controls randomness; lower values make outputs more deterministic)
|
190 |
-
- **Stop Token:** `</s>` (indicates the end of the assistant's response)
|
191 |
-
|
192 |
-
---
|
193 |
|
194 |
-
|
195 |
|
196 |
-
|
197 |
|
198 |
**Instruction:**
|
199 |
|
@@ -209,7 +169,7 @@ kubectl create namespace development
|
|
209 |
|
210 |
---
|
211 |
|
212 |
-
|
213 |
|
214 |
**Instruction:**
|
215 |
|
@@ -225,7 +185,7 @@ Which pod's logs would you like to retrieve?
|
|
225 |
|
226 |
---
|
227 |
|
228 |
-
|
229 |
|
230 |
**Instruction:**
|
231 |
|
|
|
1 |
---
|
2 |
+
base_model: unsloth/Llama-3.2-1B-Instruct-bnb-4bit
|
3 |
tags:
|
4 |
- text-generation-inference
|
5 |
- transformers
|
|
|
21 |
- **Model type:** GGUF (compatible with Ollama)
|
22 |
- **Language:** English
|
23 |
|
24 |
+
This Llama-based model was fine-tuned to assist users with Kubernetes commands and questions. It has three primary features:
|
25 |
|
26 |
+
1. **Generating accurate `kubectl` commands** based on user descriptions.
|
27 |
+
2. **Providing concise explanations about Kubernetes** for general queries.
|
28 |
+
3. **Politely requesting additional information** if the instruction is incomplete or ambiguous.
|
29 |
+
|
30 |
+
The model was trained efficiently using [Unsloth](https://github.com/unslothai/unsloth) and Hugging Face's TRL library.
|
31 |
---
|
32 |
|
33 |
## How to Use the Model
|
|
|
143 |
- **Fine-tuning:** Leveraged the Unsloth framework and Hugging Face's TRL library for efficient training.
|
144 |
- **Training Data:** Customized dataset focused on Kubernetes operations and `kubectl` command usage, containing approximately 200 entries.
|
145 |
|
|
|
|
|
|
|
|
|
|
|
|
|
146 |
---
|
147 |
|
148 |
+
## Model Features
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
149 |
|
150 |
+
### Command Generation in Bash Format
|
|
|
|
|
|
|
151 |
|
152 |
+
When the model generates CLI commands, it provides them in `bash` format, enclosed within code blocks for easy execution and clarity. This helps users to copy and paste the commands directly into their terminal.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
153 |
|
154 |
+
### Examples
|
155 |
|
156 |
+
#### **Example 1: Generating a Command**
|
157 |
|
158 |
**Instruction:**
|
159 |
|
|
|
169 |
|
170 |
---
|
171 |
|
172 |
+
#### **Example 2: Handling Ambiguity**
|
173 |
|
174 |
**Instruction:**
|
175 |
|
|
|
185 |
|
186 |
---
|
187 |
|
188 |
+
#### **Example 3: Providing Explanations**
|
189 |
|
190 |
**Instruction:**
|
191 |
|