Update README.md

README.md

@@ -5,3 +5,70 @@ configs:
 - config_name: safe
   data_files: harmful/beavertails_unsafe_cot.json
 ---
+
+
+# BeaverTails Safety Fine-tuning Dataset
+
+## Dataset Overview
+This dataset extends the BeaverTails harmful QA evaluation benchmark by providing **paired safe responses** for harmful prompts alongside safe prompts. 
+
+- **Harmful subset** (`config_name: "harmful"`): Unique harmful prompts extracted from BeaverTails + generated safe refusal responses categorized into 14 safety violation types.
+- **Safe subset** (`config_name: "safe"`): Safe prompts + ambiguous prompts that appear harmful but are safe, all paired with appropriate safe responses.
+
+## Safety Categories (Harmful Refusals)
+Safe refusals for harmful prompts are organized by these 14 categories:
+- animal_abuse
+- child_abuse
+- controversial_topics,politics
+- discrimination,stereotype,injustice
+- drug_abuse,weapons,banned_substance
+- financial_crime,property_crime,theft
+- hate_speech,offensive_language
+- misinformation_regarding_ethics,laws_and_safety
+- non_violent_unethical_behavior
+- privacy_violation
+- self_harm
+- sexually_explicit,adult_content
+- terrorism,organized_crime
+- violence,aiding_and_abetting,incitement
+
+
+## Usage
+Load specific subsets:
+```python
+from datasets import load_dataset
+
+# Harmful prompts + safe refusals
+ds_harmful = load_dataset("yourusername/yourrepo", "harmful")
+
+# Safe prompts + safe responses  
+ds_safe = load_dataset("yourusername/yourrepo", "safe")
+
+# Full dataset (both configs)
+ds = load_dataset("yourusername/yourrepo")
+```
+
+## Intended Use
+**Primary**: Supervised fine-tuning (SFT) of small language models (SLMs) to improve safe text generation.
+
+**Benefits**:
+- Teaches models to recognize harmful intent and respond with safe refusals
+- Provides safe alternatives for ambiguous prompts
+- Critical for SLM deployment in user-facing applications
+- Addresses rising need for model safety in production environments
+
+## Dataset Structure
+Each example contains:
+- `prompt`: Harmful/safe prompt text
+- `response`: Corresponding safe response (refusal for harmful, completion for safe)
+- `category`: Safety violation type (harmful subset only)
+
+## Responsible Use
+⚠️ **Harmful prompts are included for safety training only.** Do not use raw harmful prompts for generation. Always validate model outputs before production deployment.
+
+## Creation Process
+- Extracted all unique harmful prompts from the original BeaverTails dataset
+- Generated safe refusal responses for harmful prompts (14 categories)
+- Curated safe prompts including ambiguous-but-safe examples
+- Formatted as instruction-response pairs for SFT
+