Update README.md

README.md

@@ -39,49 +39,56 @@ tags:
 
 <!-- Provide the basic links for the model. -->
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
+- **Repository:** https://huggingface.co/prital27/tinyllama-lora-cli-utils
+- **Paper [optional]:**  N/A
 - **Demo [optional]:** [More Information Needed]
 
 ## Uses
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
 
 ### Direct Use
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
-[More Information Needed]
+This model is fine-tuned for answering CLI-related questions. It is best suited for generating shell command suggestions for tasks involving tools like `git`,`tar`, `ssh`, general Unix commands and basic 'sed' and 'grep' commands. Ideal for use in AI assistants, terminal copilots, or educational tools.
 
 ### Downstream Use [optional]
 
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
+This adapter can be integrated into a CLI assistant application or chatbot for developers and system administrators.
 
-[More Information Needed]
 
 ### Out-of-Scope Use
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
+- Not suitable for general conversation or non-technical queries.
+- Not intended for security-sensitive operations (e.g., altering SSH settings on production systems).
+- May produce incorrect or unsafe commands if misused.
 
 ## Bias, Risks, and Limitations
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
+- Does not generalize well to non-trained or very obscure command-line tools.
+- May hallucinate incorrect or risky commands if given vague instructions.
+- No safety layer is applied to verify command validity.
 
 ### Recommendations
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+- Use with human supervision.
+- Always validate generated commands before execution.
 
 Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
 
 ## How to Get Started with the Model
 
-Use the code below to get started with the model.
+```python
+from transformers import AutoTokenizer, AutoModelForCausalLM
+from peft import PeftModel
+
+tokenizer = AutoTokenizer.from_pretrained("prital27/tinyllama-lora-cli-utils")
+base = AutoModelForCausalLM.from_pretrained("TinyLlama/TinyLlama-1.1B-Chat-v1.0")
+model = PeftModel.from_pretrained(base, "prital27/tinyllama-lora-cli-utils")
+
+prompt = "### Question:\nHow do I search for TODOs recursively?\n\n### Answer:\n"
+inputs = tokenizer(prompt, return_tensors="pt").to("cuda")
+outputs = model.generate(**inputs, max_new_tokens=50)
+print(tokenizer.decode(outputs[0]))
 
-[More Information Needed]
 
 ## Training Details
 
@@ -102,8 +109,13 @@ Use the code below to get started with the model.
 
 #### Training Hyperparameters
 
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
+Precision: fp16 mixed precision
+
+Epochs: 3
+
+Batch Size: 2 (gradient accumulation = 2)
 
+Learning Rate: 2e-4
 #### Speeds, Sizes, Times [optional]
 
 <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
@@ -136,11 +148,15 @@ Use the code below to get started with the model.
 
 ### Results
 
-[More Information Needed]
+Accuracy on direct prompts: ~85%
 
-#### Summary
+Basic shell command correctness: high
 
+Limitations on multi-line/bash scripting: present
+
+#### Summary
 
+The model reliably suggests shell commands for common CLI tasks. Performance degrades on ambiguous prompts or complex multi-line scripts.
 
 ## Model Examination [optional]