Update README.md

README.md

@@ -1,25 +1,6 @@
----
-license: apache-2.0
-tags:
-- code
-- security
-- secure-coding
-language:
-- en
-pipeline_tag: text-generation
----
-from pathlib import Path
-
-readme = """---
-license: apache-2.0
-tags:
-  - code
-  - security
-  - secure-coding
-language:
-  - en
-pipeline_tag: text-generation
----
+\---
+
+## license: apache-2.0
 
 # Cipheron
 
@@ -31,8 +12,8 @@ It analyzes source code for common security vulnerabilities and attempts to expl
 
 Cipheron performs particularly well on:
 
-- **SQL injection** — identifying unsafe query construction and recommending parameterized queries.
-- **Command injection** — identifying unsafe shell command construction and recommending safer subprocess-based approaches.
+* **SQL injection** — identifies unsafe query construction and recommends parameterized queries.
+* **Command injection** — identifies unsafe shell command construction and recommends safer subprocess-based approaches.
 
 These vulnerability classes are strongly represented in its evaluation data.
 
@@ -42,12 +23,12 @@ Cipheron has limited reliability across many security vulnerability categories.
 
 In testing, it struggled with:
 
-- Path traversal
-- Hardcoded secrets and API keys
-- Weak password hashing
-- Insecure deserialization
-- Reflected XSS
-- Complex multi-step security vulnerabilities
+* Path traversal
+* Hardcoded secrets and API keys
+* Weak password hashing
+* Insecure deserialization
+* Reflected XSS
+* Complex multi-step security vulnerabilities
 
 For these cases, the model may produce changes that appear security-related but do not actually eliminate the underlying vulnerability.
 
@@ -61,10 +42,12 @@ Cipheron is best considered a lightweight, experimental tool for first-pass secu
 from transformers import AutoModelForCausalLM, AutoTokenizer
 import torch
 
-tokenizer = AutoTokenizer.from_pretrained("bencodez/Cipheron")
+model_id = "bencodez/Cipheron"
+
+tokenizer = AutoTokenizer.from_pretrained(model_id)
 
 model = AutoModelForCausalLM.from_pretrained(
-    "bencodez/Cipheron",
+    model_id,
     torch_dtype=torch.bfloat16
 )
 
@@ -84,24 +67,63 @@ messages = [
 def get_user(username):
     query = "SELECT * FROM users WHERE username = '" + username + "'"
     return db.execute(query)"""
-    },
+    }
 ]
 
 input_ids = tokenizer.apply_chat_template(
     messages,
     add_generation_prompt=True,
-    return_tensors="pt",
-    return_dict=False
+    return_tensors="pt"
 )
 
-out = model.generate(
-    input_ids,
-    max_new_tokens=250
+with torch.no_grad():
+    output = model.generate(
+        input_ids,
+        max_new_tokens=250
+    )
+
+response = tokenizer.decode(
+    output[0][input_ids.shape[1]:],
+    skip_special_tokens=True
 )
 
-print(
-    tokenizer.decode(
-        out[0][input_ids.shape[1]:],
-        skip_special_tokens=True
-    )
-)
+print(response)
+```
+
+## Local Inference
+
+A quantized `Cipheron-Q8_0.gguf` version is available for lightweight local inference.
+
+Cipheron can be used with compatible local inference runtimes for CPU and other supported devices.
+
+## Intended Use
+
+Cipheron is intended for:
+
+* Secure-coding education
+* Security experimentation
+* Offline code analysis
+* Vulnerability-detection research
+* Lightweight local development workflows
+
+## Model Information
+
+| Property       | Value                              |
+| -------------- | ---------------------------------- |
+| Model          | Cipheron                           |
+| Parameters     | 0.5B                               |
+| Architecture   | Causal language model              |
+| Primary domain | Secure coding                      |
+| Input          | Source code and security questions |
+| Output         | Security analysis and safer code   |
+| License        | Apache 2.0                         |
+
+## Disclaimer
+
+Cipheron is an experimental security-oriented coding model.
+
+Security output should always be independently verified before being used in production systems. A model-generated fix does not guarantee that a vulnerability has been completely eliminated.
+
+## License
+
+Apache 2.0