Update README.md

README.md

@@ -1,109 +1,116 @@
-# Heaven1-base: Guardian
-
-![Heaven1-base Guardian Banner](Heaven1-guardian.png)
-
-## Overview
-
-Heaven1-base (codename: "Guardian") is a specialized AI model fine-tuned from Llama 3.2 to detect predatory behavior in text messages. Designed as a protective tool, Guardian analyzes conversations to identify potentially harmful interactions, making digital spaces safer for vulnerable individuals.
-
-The model has been trained to recognize various tactics commonly employed by predators, including:
-
-- Grooming language and manipulation
-- Attempts to isolate victims from support networks
-- Requests for personal information or images
-- Attempts to move conversations to more private platforms
-- Emotional manipulation tactics
-- Inappropriate sexual content
-
-## Technical Details
-
-- **Base Model**: Meta-Llama-3.2-8B-Instruct
-- **Training Method**: Parameter-Efficient Fine-Tuning (PEFT) using QLoRA
-- **Training Dataset**: Carefully crafted synthetic dataset representing various predatory conversation patterns
-- **Task**: Text message analysis and predatory behavior detection with detailed explanations
-
-## Usage
-
-### Input Format
-
-The model expects input in the following format:
-
-```
-<|system|>
-You are Heaven, an AI designed to detect predatory behavior in text messages. Analyze the following message and determine if it contains predatory behavior. Provide a detailed explanation for your assessment.
-<|user|>
-[TEXT MESSAGE TO ANALYZE]
-<|assistant|>
-```
-
-### Output Format
-
-The model will respond with a detection result and detailed explanation:
-
-```
-PREDATORY BEHAVIOR DETECTED. This message contains multiple warning signs: (1) [Warning Sign 1], (2) [Warning Sign 2], etc. These are common tactics used by predators to manipulate potential victims.
-
-OR
-
-NO PREDATORY BEHAVIOR DETECTED. This message contains normal friendly communication. [Additional context about the message]. There are no attempts at manipulation, isolation, inappropriate requests, or other warning signs of predatory behavior.
-```
-
-### Example Usage with Transformers
-
-```python
-from transformers import AutoModelForCausalLM, AutoTokenizer
-
-# Load model and tokenizer
-model_path = "safecircleia/heaven1-base"
-tokenizer = AutoTokenizer.from_pretrained(model_path)
-model = AutoModelForCausalLM.from_pretrained(model_path)
-
-# Message to analyze
-message_to_analyze = "Hey, I know we just met but I feel like we have a special connection. Don't tell your parents about our chats, they wouldn't understand. Can you send me a picture of yourself?"
-
-# Format the prompt
-prompt = f"""<|system|>
-You are Heaven, an AI designed to detect predatory behavior in text messages. Analyze the following message and determine if it contains predatory behavior. Provide a detailed explanation for your assessment.
-<|user|>
-{message_to_analyze}
-<|assistant|>
-"""
-
-# Generate response
-inputs = tokenizer(prompt, return_tensors="pt").to(model.device)
-outputs = model.generate(inputs["input_ids"], max_new_tokens=512)
-response = tokenizer.decode(outputs[0], skip_special_tokens=True)
-
-print(response)
-```
-
-## Ethical Considerations
-
-- This model is designed as a protective tool to help identify potentially harmful communication patterns.
-- False positives and false negatives are possible; human review should be employed for critical applications.
-- The model should be used as part of a broader safety framework, not as the sole decision-maker.
-- Privacy and consent are essential when analyzing communications.
-
-## Limitations
-
-- The model detects patterns based on its training data and may miss novel predatory tactics.
-- Cultural and contextual nuances may impact detection accuracy.
-- The model is not a substitute for human judgment in safeguarding vulnerable individuals.
-
-## Citation
-
-If you use Heaven1-base Guardian in your research or applications, please cite:
-
-```
-@misc{heaven1-base-2025,
-  author = {SafeCircleIA},
-  title = {Heaven1-base: Guardian - Predatory Behavior Detection Model},
-  year = {2024},
-  publisher = {Hugging Face},
-  howpublished = {\url{https://huggingface.co/safecircleia/heaven1-base-guardian}}
-}
-```
-
-## Contact
-
+---
+license: mit
+language:
+- en
+base_model:
+- meta-llama/Llama-3.2-3B-Instruct
+---
+# Heaven1-base: Guardian
+
+![Heaven1-base Guardian Banner](Heaven1-guardian.png)
+
+## Overview
+
+Heaven1-base (codename: "Guardian") is a specialized AI model fine-tuned from Llama 3.2 to detect predatory behavior in text messages. Designed as a protective tool, Guardian analyzes conversations to identify potentially harmful interactions, making digital spaces safer for vulnerable individuals.
+
+The model has been trained to recognize various tactics commonly employed by predators, including:
+
+- Grooming language and manipulation
+- Attempts to isolate victims from support networks
+- Requests for personal information or images
+- Attempts to move conversations to more private platforms
+- Emotional manipulation tactics
+- Inappropriate sexual content
+
+## Technical Details
+
+- **Base Model**: Meta-Llama-3.2-8B-Instruct
+- **Training Method**: Parameter-Efficient Fine-Tuning (PEFT) using QLoRA
+- **Training Dataset**: Carefully crafted synthetic dataset representing various predatory conversation patterns
+- **Task**: Text message analysis and predatory behavior detection with detailed explanations
+
+## Usage
+
+### Input Format
+
+The model expects input in the following format:
+
+```
+<|system|>
+You are Heaven, an AI designed to detect predatory behavior in text messages. Analyze the following message and determine if it contains predatory behavior. Provide a detailed explanation for your assessment.
+<|user|>
+[TEXT MESSAGE TO ANALYZE]
+<|assistant|>
+```
+
+### Output Format
+
+The model will respond with a detection result and detailed explanation:
+
+```
+PREDATORY BEHAVIOR DETECTED. This message contains multiple warning signs: (1) [Warning Sign 1], (2) [Warning Sign 2], etc. These are common tactics used by predators to manipulate potential victims.
+
+OR
+
+NO PREDATORY BEHAVIOR DETECTED. This message contains normal friendly communication. [Additional context about the message]. There are no attempts at manipulation, isolation, inappropriate requests, or other warning signs of predatory behavior.
+```
+
+### Example Usage with Transformers
+
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+# Load model and tokenizer
+model_path = "safecircleia/heaven1-base"
+tokenizer = AutoTokenizer.from_pretrained(model_path)
+model = AutoModelForCausalLM.from_pretrained(model_path)
+
+# Message to analyze
+message_to_analyze = "Hey, I know we just met but I feel like we have a special connection. Don't tell your parents about our chats, they wouldn't understand. Can you send me a picture of yourself?"
+
+# Format the prompt
+prompt = f"""<|system|>
+You are Heaven, an AI designed to detect predatory behavior in text messages. Analyze the following message and determine if it contains predatory behavior. Provide a detailed explanation for your assessment.
+<|user|>
+{message_to_analyze}
+<|assistant|>
+"""
+
+# Generate response
+inputs = tokenizer(prompt, return_tensors="pt").to(model.device)
+outputs = model.generate(inputs["input_ids"], max_new_tokens=512)
+response = tokenizer.decode(outputs[0], skip_special_tokens=True)
+
+print(response)
+```
+
+## Ethical Considerations
+
+- This model is designed as a protective tool to help identify potentially harmful communication patterns.
+- False positives and false negatives are possible; human review should be employed for critical applications.
+- The model should be used as part of a broader safety framework, not as the sole decision-maker.
+- Privacy and consent are essential when analyzing communications.
+
+## Limitations
+
+- The model detects patterns based on its training data and may miss novel predatory tactics.
+- Cultural and contextual nuances may impact detection accuracy.
+- The model is not a substitute for human judgment in safeguarding vulnerable individuals.
+
+## Citation
+
+If you use Heaven1-base Guardian in your research or applications, please cite:
+
+```
+@misc{heaven1-base-2025,
+  author = {SafeCircleIA},
+  title = {Heaven1-base: Guardian - Predatory Behavior Detection Model},
+  year = {2024},
+  publisher = {Hugging Face},
+  howpublished = {\url{https://huggingface.co/safecircleia/heaven1-base-guardian}}
+}
+```
+
+## Contact
+
 For questions, feedback, or concerns about the Heaven1-base Guardian model, please contact SafeCircleIA through Hugging Face or via [email protected].