2025.07.08/14:21

README.md

@@ -1,11 +1,82 @@
-# Double Model
+---
+language: "en"
+license: "mit"
+tags:
+  - toy-model
+  - beginner
+  - number
+  - demo
+  - simple
+model_type: "custom"
+pipeline_tag: "other"
+---
 
-This is a toy model that doubles any number you give it.
+# 🧠 Double Model
 
-Example:
+A tiny demonstration model that simply **doubles any number** you give it.
+
+This is **not a machine learning model**, but a toy example to show how to upload custom models to [Hugging Face Hub](https://huggingface.co/).
+
+---
+
+## 📦 How It Works
+
+The model has one method:
+
+```python
+def predict(number):
+    return number * 2
+```
+
+That’s it. No training, no weights — just logic.
+
+---
+
+## 🛠️ Usage Example
 
 ```python
 from double_model import DoubleModel
+
 model = DoubleModel()
-print(model.predict(5))  # ➜ 10
+print(model.predict(10))  # ➜ 20
 ```
+
+If you're loading from a `.pkl` file:
+
+```python
+import pickle
+
+with open("double_model.pkl", "rb") as f:
+    model = pickle.load(f)
+
+print(model.predict(7))  # ➜ 14
+```
+
+---
+
+## 📁 Files Included
+
+- `double_model.py` — the model class  
+- `double_model.pkl` — the pickled version of the model  
+- `README.md` — model card
+
+---
+
+## 📄 License
+
+This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).
+
+---
+
+## ✨ Why This Exists
+
+To demonstrate:
+- How to create simple Python-based models
+- How to package and upload to Hugging Face Hub
+- How even non-ML logic can be versioned and shared like models
+
+---
+
+## 🤖 Author
+
+[goldendevuz](https://huggingface.co/goldendevuz)