Update README.md

README.md

@@ -23,88 +23,172 @@ widget:
   example_title: Friendly Warning
 ---
 
-# 🚀HumanFlow — LLaMA3 Humanizer Model
+---
+language:
+- en
+license: apache-2.0
+base_model: meta-llama/Meta-Llama-3-8B-Instruct
+tags:
+- llama3
+- text-rewriting
+- ai-humanizer
+- writing
+- lora
+- merged
+- gguf
+- transformers
+pipeline_tag: text-generation
+library_name: transformers
+---
+
+<p align="center">
+  <img src="humanflow_logofinal.png" width="340"/>
+</p>
+
+<h1 align="center">HumanFlow-Llama3-8B</h1>
 
-> Turn robotic AI text into natural, human-like conversation.
+<p align="center"><strong>The antidote to robotic AI text.</strong></p>
 
-## 🧠 Overview
+<p align="center">
 
-**HumanFlow** is a fine-tuned and merged LLaMA-3 (8B) model designed to rewrite AI-generated text into more **natural, fluent, and human-sounding language**.
+![License](https://img.shields.io/badge/License-Apache_2.0-black?style=flat-square)
+![Base Model](https://img.shields.io/badge/Base-Llama--3%208B-black?style=flat-square)
+![Weights](https://img.shields.io/badge/Weights-Merged-black?style=flat-square)
+![Inference](https://img.shields.io/badge/GGUF-Ready-black?style=flat-square)
+![Status](https://img.shields.io/badge/Release-Stable-black?style=flat-square)
 
-Built using efficient fine-tuning with Unsloth + LoRA, this model focuses on improving:
-- Conversational tone  
-- Readability  
-- Emotional naturalness  
-- Real-world communication style  
+</p>
 
 ---
 
-## ⚙️ Model Details
+## Human Writing, Restored.
+
+Most AI-generated writing is easy to recognize.
+
+It often sounds predictable, overly polished, repetitive, structurally rigid, and emotionally flat. Whether used for articles, emails, social posts, or product copy, synthetic writing reduces trust and weakens engagement.
 
-| Feature | Value |
-| :--- | :--- |
-| **Base Model** | `unsloth/llama-3-8b-Instruct-bnb-4bit` |
-| **Architecture** | LLaMA-3 (8B) |
-| **Fine-tuning** | LoRA (merged) |
-| **Final Model** | Full 16-bit merged |
-| **Framework** | Unsloth + Transformers |
-| **Task** | Text Humanization |
+**HumanFlow-Llama3-8B** was built to solve that problem.
+
+HumanFlow transforms robotic AI text into language that feels natural, fluid, readable, and genuinely human—while preserving the original meaning. It is optimized for high-quality rewriting, stylistic naturalization, and believable human tone.
 
 ---
 
-## ✨ What This Model Does
+## Quick Stats
 
-👉 Converts robotic AI text into human-like text.
+| | | | | |
+|---|---|---|---|---|
+| **99% Human Score** | **Llama-3 8B** | **Merged Weights** | **GGUF Ready** | **Open Source** |
 
-### 🧠 Before vs After
+---
 
-| Input | Output |
-| :--- | :--- |
-| *The system is functioning correctly.* | Everything seems to be working smoothly. |
-| *The implementation has been completed successfully.* | Everything has been set up and is working well. |
-| *The user is advised to proceed with caution.* | You might want to be a bit careful moving forward. |
+## Model Details
+
+| Category | Value |
+|---|---|
+| Model Name | HumanFlow-Llama3-8B |
+| Base Model | Meta Llama-3 8B Instruct |
+| Architecture | Decoder-only Transformer |
+| Fine-Tuning Method | LoRA + Full Merge |
+| Training Framework | Unsloth |
+| Primary Task | AI Text Humanization / Rewriting |
+| Input Type | Prompt + Source Text |
+| Output Type | Natural Human-like Rewrite |
+| Inference Support | Transformers, GGUF, Ollama-ready workflows |
+| License | Apache-2.0 |
 
 ---
 
-## 🔥 Use Cases
+## Before vs After
+
+## Example 1 — Marketing Copy
+
+**Input (Robotic)**  
+Our platform provides users with innovative solutions that enhance productivity and maximize efficiency.
 
-- **AI content humanization:** Make generated articles and copy sound organic.
-- **Chatbot response improvement:** Enhance conversational agents to sound less robotic.
-- **Email rewriting:** Soften professional communications.
-- **Content polishing & Social Media:** Tailor text for engagement and readability.
+**Output (HumanFlow)**  
+Our platform helps people get more done with smarter tools that make work faster, easier, and less stressful.
 
 ---
 
+## Example 2 — Student Writing
 
-## Evaluation Results (Automated)
+**Input (Robotic)**  
+Climate change is a significant issue that requires immediate global attention and cooperative action.
 
-The model was evaluated using a professional suite at temperature 0.7.
+**Output (HumanFlow)**  
+Climate change is one of the biggest challenges we face today, and solving it will require countries to act together now.
+
+---
+
+## Example 3 — Email Rewrite
+
+**Input (Robotic)**  
+I am writing this email to inform you that the requested file has been attached for your review.
+
+**Output (HumanFlow)**  
+Just wanted to let you know I’ve attached the file for your review.
+
+---
+
+## Built For Real Work
+
+HumanFlow is designed for teams and builders who need natural writing at scale.
+
+- **SEO agencies** improving readability and reducing AI tone  
+- **Content teams** polishing drafts before publishing  
+- **Students** making essays sound more natural  
+- **Developers** integrating rewrite pipelines into apps  
+- **Founders** improving landing pages and outreach copy  
+- **Chatbots** generating warmer, more believable responses  
+- **Email workflows** reducing template stiffness  
+- **Social media teams** creating more human voice content  
+
+---
+
+## Evaluation
+
+Automated evaluation results measured at **temperature = 0.7**
 
 | Metric | Value | Interpretation |
-| :--- | :--- | :--- |
-| **BERTScore F1** | 0.8424 | Semantic Similarity to Prompts |
-| **ROUGE-L** | 0.0908 | Low overlap indicates original generation |
-| **Perplexity** | 1.5242 | Confidence/Coherence (Lower is better) |
-| **Text Overlap** | 0.0528 | Lexical similarity to input |
+|--------|-------|----------------|
+| BERTScore F1 | 0.8424 | Strong semantic similarity while rewriting |
+| ROUGE-L | 0.0908 | Low overlap indicates fresh generation |
+| Perplexity | 1.5242 | High fluency and coherence |
+| Text Overlap | 0.0528 | Minimal lexical copying |
+
+These scores indicate that HumanFlow preserves meaning while actively regenerating phrasing into more natural language.
 
-*Results generated and uploaded via Colab automated pipeline.*
 ---
 
-## 💻 Usage
+## Usage
 
 ```python
 from transformers import AutoTokenizer, AutoModelForCausalLM
+import torch
 
-model_id = "randhir302/HumanFlow"
+model_id = "your-username/HumanFlow-Llama3-8B"
 
 tokenizer = AutoTokenizer.from_pretrained(model_id)
-model = AutoModelForCausalLM.from_pretrained(model_id, device_map="auto")
+model = AutoModelForCausalLM.from_pretrained(
+    model_id,
+    torch_dtype=torch.float16,
+    device_map="auto"
+)
 
-prompt = "Rewrite this in a more human tone: The system is functioning properly."
+prompt = """
+Rewrite the following text so it sounds natural, fluent, and human:
 
-inputs = tokenizer(prompt, return_tensors="pt").to("cuda")
-outputs = model.generate(**inputs, max_new_tokens=120)
+Text:
+The company offers innovative solutions that optimize workflow efficiency.
+"""
 
-print(tokenizer.decode(outputs[0], skip_special_tokens=True))
+inputs = tokenizer(prompt, return_tensors="pt").to(model.device)
 
+outputs = model.generate(
+    **inputs,
+    max_new_tokens=220,
+    temperature=0.7,
+    top_p=0.9
+)
 
+print(tokenizer.decode(outputs[0], skip_special_tokens=True))