Update README.md

README.md

@@ -1,3 +1,29 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+language:
+- fa
+metrics:
+- accuracy
+base_model:
+- HooshvareLab/bert-fa-base-uncased
+---
+
+# Hamnevise
+Persian Diacritization using masked-language model(MLM) with`HooshvareLab/bert-fa-base-uncased` for the words with same written form but different spelling in a given sentence.
+
+**Architecture:**
+```
+Input → ParsBERT (context) + Char CNN (morphology)
+     → Shared Fusion
+     → Word-Specific Classifiers
+     → Only valid outputs per word
+```
+
+## 📊 Dataset Format
+CSV file with three columns:
+
+```csv
+sentence,word,word_with_diacritics
+اشکال در سیستم گرمایش، باعث سرد شدن ساختمان شد.,اشکال,اِشکال
+اشکال در فرهنگ‌های باستانی، نمادها و معانی خاصی داشته‌اند.,اشکال,اَشکال
+```