Update README.md

README.md

@@ -63,6 +63,54 @@ license_link: LICENSE
 # LFM2-350M-PII-Extract-JP
 
 Based on [LFM2-350M](https://huggingface.co/LiquidAI/LFM2-350M), LFM2-350M-PII-Extract-JP is designed to **extract personally identifiable information (PII) from Japanese text and output it in JSON format.**
-The resulting data can then be used to mask sensitive information.
+The output can then be used to mask sensitive information.
 
+In particular, it is trained to extract:
+* Address/Locations
+* Company/Institute/Organization names
+* Email addresses
+* Human names
+* Phone numbers
+from Japanese documents and texts.
 
+## Extraction Quality 
+
+WIP
+
+## Model Details
+
+**Generation parameters**: We strongly recommend using greedy decoding with a `temperature=0`.
+
+**System prompts**: This checkpoint **requires** the following system prompt:
+* `Extract <address>, <company_name>, <email_address>, <human_name>, <phone_number>`
+
+Note the model can handle extraction of particular entities. E.g. The model will only output human names when the system prompt is set to `Extract <human_name>`.
+
+> [!WARNING]
+> ⚠️ For best performance, ensure alphabetical order of entity categories as shown above.
+
+**Chat template**: LFM2-PII-Extract-JP uses a ChatML-like chat template as follows:
+
+```
+<|startoftext|><|im_start|>system
+Extract <address>, <company_name>, <email_address>, <human_name>, <phone_number><|im_end|>
+<|im_start|>user
+こんにちは、ラミンさんに B200 GPU を 10000 台 至急請求してください。連絡先は [email protected] (電話番号010-000-0000) で、これは C. elegans 線虫に着想を得たニューラルネットワークアーキテクチャを 今すぐ構築するために不可欠です。<|im_end|>
+<|im_start|>assistant
+{"address": [], "company_name": [], "email_address": ["[email protected]"], "human_name": ["ラミン"], "phone_number": ["010-000-0000"]}<|im_end|>
+```
+
+You can automatically apply it using the dedicated [`.apply_chat_template()`](https://huggingface.co/docs/transformers/en/chat_templating#applychattemplate) function from Hugging Face transformers.
+
+> [!WARNING]
+> ⚠️ The model is intended for single turn conversations.
+
+## 🏃 How to run LFM2
+
+- Huggingface: [LFM2-350M](https://huggingface.co/LiquidAI/LFM2-350M)
+- llama.cpp: [LFM2-350M-PII-Extract-JP-GGUF](https://huggingface.co/LiquidAI/LFM2-350M-PII-Extract-JP-GGUF)
+- LEAP: [LEAP model library](https://leap.liquid.ai/models?model=lfm2-350m-pii-extract-jp)
+
+## 📬 Contact
+
+If you are interested in custom solutions with edge deployment, please contact [our sales team](https://www.liquid.ai/contact).