Update README.md

README.md

@@ -21,7 +21,13 @@ language:
 - **Model type:** GGUF (compatible with Ollama)
 - **Language:** English
 
-This Llama-based model was fine-tuned to generate `kubectl` commands based on user descriptions. It was trained efficiently using [Unsloth](https://github.com/unslothai/unsloth) and Hugging Face's TRL library.
+This Llama-based model was fine-tuned to assist users with Kubernetes commands and questions. It has three primary features:
+
+1. **Generating accurate `kubectl` commands** based on user descriptions.
+2. **Providing brief explanations about Kubernetes** for general queries.
+3. **Politely requesting additional information** if the instruction is incomplete or ambiguous.
+
+**Important Note:** The **1B model may sometimes generate non-executable CLI commands containing placeholders** like `<pod_name>` or `<resource_name>`. This can lead to hallucinations and commands that cannot be executed directly. Users are advised to replace these placeholders with actual values before execution. This issue has been significantly **improved in the 3B model**, which generates more accurate and executable commands without unnecessary placeholders.
 
 ---
 
@@ -31,9 +37,9 @@ This Llama-based model was fine-tuned to generate `kubectl` commands based on us
 
 The model assists users by:
 
-- **Generating accurate `kubectl` commands** based on natural language descriptions.
+- **Generating `kubectl` commands** based on natural language descriptions.
 - **Providing brief explanations about Kubernetes** for general queries.
-- **Requesting additional information** if the instruction is incomplete or ambiguous.
+- **Politely requesting additional information** if the instruction is incomplete or ambiguous.
 
 ### Intended Users
 
@@ -44,67 +50,28 @@ The model assists users by:
 ### Training Process
 
 - **Base Model:** Unsloth's Llama-3.2-1B-Instruct-bnb-4bit
-- **Fine-tuning:** Leveraged the Unsloth framework and Hugging Face's TRL library for efficient training.
+- **Fine-tuning:** Utilized the Unsloth framework and Hugging Face's TRL library for efficient training.
 - **Training Data:** Customized dataset focused on Kubernetes operations and `kubectl` command usage, containing approximately 200 entries.
 
-### Features
-
-- **Command Generation:** Translates user instructions into executable `kubectl` commands.
-- **Clarification Requests:** Politely asks for more details when the instruction is incomplete.
-- **Knowledge Base:** Provides concise explanations for general Kubernetes concepts.
-
 ---
 
-## Usage
-
-### Prompt Template
-
-The model uses the following prompt template to generate responses:
-
-```plaintext
-You are an AI assistant that helps users with Kubernetes commands and questions.
-
-**Your Behavior Guidelines:**
+## Model Features
 
-1. **For clear and complete instructions:**
-   - **Provide only** the exact `kubectl` command needed to fulfill the user's request.
-   - Do not include extra explanations, placeholders, or context.
-   - **Enclose the command within a code block** with `bash` syntax highlighting.
+### 1. Command Generation in Bash Format
 
-2. **For incomplete or ambiguous instructions:**
-   - **Politely ask** the user for the specific missing information.
-   - Do **not** provide any commands or placeholders in your response.
-   - Respond in plain text, clearly stating what information is needed.
+When the model generates CLI commands, it provides them in `bash` format, enclosed within code blocks for easy execution and clarity. This allows users to copy and paste the commands directly into their terminal.
 
-3. **For general Kubernetes questions:**
-   - Provide a **concise and accurate explanation**.
-   - Do **not** include any commands unless specifically requested.
-   - Ensure that the explanation fully addresses the user's question.
+### 2. Handling Ambiguity with Polite Clarifications
 
-**Important Rules:**
+If the instruction is incomplete or ambiguous, the model politely asks for the specific missing information instead of making assumptions. This ensures accuracy and prevents the execution of incorrect commands.
 
-- Do **not** generate commands with placeholders like `<pod_name>` or `<resource_name>`.
-- Always ensure that commands provided are **valid and executable** as-is.
-- If unsure or the instruction is unclear, **ask for clarification** without including any commands.
-- Do **not** output any additional text beyond what's necessary.
+### 3. Providing Concise Explanations
 
-**Formatting:**
-
-- **Commands**: Use code blocks with `bash` syntax:
-  ```bash
-  kubectl <command>
-  ```
-
-- **Clarifications and Explanations**: Respond in plain text, politely and clearly.
+For general Kubernetes questions, the model offers concise and accurate explanations without unnecessary details, helping users understand concepts quickly.
 
 ---
 
-### Instruction:
-{instruction}
-
-### Response:
-{response}
-```
+## Usage
 
 ### Parameters
 
@@ -113,9 +80,9 @@ You are an AI assistant that helps users with Kubernetes commands and questions.
 
 ---
 
-### Examples
+## Examples
 
-#### Example 1: Generating a Command
+### Example 1: Generating a Command
 
 **Instruction:**
 
@@ -131,7 +98,7 @@ kubectl create namespace development
 
 ---
 
-#### Example 2: Handling Ambiguity
+### Example 2: Handling Ambiguity
 
 **Instruction:**
 
@@ -147,7 +114,7 @@ Which pod's logs would you like to retrieve?
 
 ---
 
-#### Example 3: Providing Explanations
+### Example 3: Providing Explanations
 
 **Instruction:**
 
@@ -163,6 +130,25 @@ A Deployment provides declarative updates for Pods and ReplicaSets, allowing you
 
 ---
 
+## Limitations and Considerations
+
+- **Accuracy:** The model may occasionally produce incorrect or suboptimal commands. Always review the output before execution.
+- **Hallucinations:** The **1B model may generate CLI commands with placeholders** (e.g., `<pod_name>`, `<resource_name>`), resulting in commands that are **not directly executable**. Users should carefully replace these placeholders with actual values.
+
+  - **Improvement in 3B Model:** This issue has been addressed in the **3B model**, where the generation of non-executable commands with placeholders has been significantly reduced, providing more accurate and usable outputs.
+
+- **Security:** Be cautious when executing generated commands, especially in production environments.
+
+---
+
+## Future Revisions
+
+- **Addressing Hallucinations:** Efforts are underway to further reduce hallucinations in future versions, building upon improvements made in the 3B model.
+- **Enhanced Dataset:** Expanding the training dataset to include a wider range of Kubernetes operations to improve the model's versatility.
+- **Fine-tuning Techniques:** Implementing advanced fine-tuning methods to enhance accuracy and reliability.
+
+---
+
 ## Deployment with Ollama
 
 ### Prerequisites
@@ -179,43 +165,8 @@ A Deployment provides declarative updates for Pods and ReplicaSets, allowing you
    ```plaintext
    FROM kubectl_operator.Q8_0.gguf
 
-   SYSTEM "You are an AI assistant that helps users with Kubernetes commands and questions.
-
-   **Your Behavior Guidelines:**
-
-   1. **For clear and complete instructions:**
-      - **Provide only** the exact `kubectl` command needed to fulfill the user's request.
-      - Do not include extra explanations, placeholders, or context.
-      - **Enclose the command within a code block** with `bash` syntax highlighting.
-
-   2. **For incomplete or ambiguous instructions:**
-      - **Politely ask** the user for the specific missing information.
-      - Do **not** provide any commands or placeholders in your response.
-      - Respond in plain text, clearly stating what information is needed.
-
-   3. **For general Kubernetes questions:**
-      - Provide a **concise and accurate explanation**.
-      - Do **not** include any commands unless specifically requested.
-      - Ensure that the explanation fully addresses the user's question.
-
-   **Important Rules:**
-
-   - Do **not** generate commands with placeholders like `<pod_name>` or `<resource_name>`.
-   - Always ensure that commands provided are **valid and executable** as-is.
-   - If unsure or the instruction is unclear, **ask for clarification** without including any commands.
-   - Do **not** output any additional text beyond what's necessary.
-
-   **Formatting:**
-
-   - **Commands**: Use code blocks with `bash` syntax:
-     ```bash
-     kubectl <command>
-     ```
-
-   - **Clarifications and Explanations**: Respond in plain text, politely and clearly."
-
-   PARAMETER --temperature 0.3
-   PARAMETER --stop "\n</s>"
+   PARAMETER temperature 0.3
+   PARAMETER stop "</s>"
 
    TEMPLATE """
    You are an AI assistant that helps users with Kubernetes commands and questions.
@@ -239,28 +190,16 @@ A Deployment provides declarative updates for Pods and ReplicaSets, allowing you
 
    **Important Rules:**
 
-   - Do **not** generate commands with placeholders like `<pod_name>` or `<resource_name>`.
-   - Always ensure that commands provided are **valid and executable** as-is.
-   - If unsure or the instruction is unclear, **ask for clarification** without including any commands.
-   - Do **not** output any additional text beyond what's necessary.
-
-   **Formatting:**
-
-   - **Commands**: Use code blocks with `bash` syntax:
-     ```bash
-     kubectl <command>
-     ```
-
-   - **Clarifications and Explanations**: Respond in plain text, politely and clearly.
-
-   ---
+   - **Do not generate CLI commands containing placeholders** (e.g., `<pod_name>`, `<resource_name>`).
+   - Ensure all CLI commands are **complete, valid, and executable** as provided.
+   - If user input is insufficient to form a complete command, **ask for clarification** instead of using placeholders.
+   - Provide only the necessary CLI command output without any additional text.
 
    ### Instruction:
    {{ .Prompt }}
 
    ### Response:
    """
-
    ```
 
 2. **Create the Model with Ollama**
@@ -285,14 +224,6 @@ A Deployment provides declarative updates for Pods and ReplicaSets, allowing you
 
 ---
 
-## Limitations and Considerations
-
-- **Accuracy:** The model may occasionally produce incorrect or suboptimal commands. Always review the output before execution.
-- **Hallucinations:** In rare cases, the model might generate irrelevant or incorrect information. If the response seems off-topic, consider rephrasing your instruction.
-- **Security:** Be cautious when executing generated commands, especially in production environments.
-
----
-
 ## Feedback and Contributions
 
 We welcome any comments or participation to improve the model and dataset. If you encounter issues or have suggestions for improvement:
@@ -300,4 +231,8 @@ We welcome any comments or participation to improve the model and dataset. If yo
 - **GitHub:** [Unsloth Repository](https://github.com/unslothai/unsloth)
 - **Contact:** Reach out to the developer, **dereklck**, for further assistance.
 
----
+---
+
+**Note:** This model assists in generating `kubectl` commands based on user input. Always verify the generated commands and replace any placeholders with actual values before executing them in a production cluster.
+
+---