Update README.md

README.md

@@ -2,19 +2,71 @@
 license: cc-by-4.0
 language:
 - he
+inference: false
 ---
+# **DictaLM**: A Large Generative Language Model for Modern Hebrew 
 
-# DictaLM - 7B parameters - Instruct Model 
+A large generative pretrained transformer (GPT) language model for Hebrew, released [link to be added].
 
-When initializing you must specify `trust_remote_code=True`
+This model was fine-tuned for instructions:
+- General questions: 
+    ```
+    מה זה בית ספר?
+    ```
 
-A few notes about the model:
+    ```
+    קיבלתי חתך קל באצבע. מהי הדרך הנכונה לטפל בזה?
+    ```
+- Simple tasks:
+    ```
+    תציע כמה רעיונות לפעילות עם ילדים בני 5:
+    ```
+- Information retrieval from a paragraph context:
+     
+    ```
+        המסיק הידני הוא הדרך המסורתית והעתיקה לקטיף זיתים. שיטה זו דורשת כוח אדם רב באופן יחסי ועדיין מקובלת בישראל ובמקומות רבים בעולם. שיטות מסיק ידני מאפשרות חיסכון עלויות במקומות בהם כוח האדם זול ועלות השיטות הממוכנות גבוהה. לזיתים המיועדים למאכל (לכבישה, בניגוד לזיתים לשמן) מתאים יותר מסיק ידני כיוון שהפרי פחות נפגע במהלך המסיק בשיטה זו (פגיעות בקליפת הפרי בזיתים לשמן פחות משמעותיות). כמו כן מועדף מסיק ידני באזורים בהם הטופוגרפיה המקומית או צפיפות העצים לא מאפשרים גישה נוחה לכלים מכנים. השיטה הידנית מאפשרת גם למסוק עצים שונים במועדים שונים, בהתאם לקצב הבשלת הפרי הטבעי בכל עץ.
+        
+        על בסיס הפסקה הזאת, מה הוא היתרון של מסיק ידני מבחינת קצב הבשלת הפרי?
+    ```
 
-- This is an alpha version of the model, and there are many improvements to come.
-- The model works better for tasks of information retrieval (given a paragraph and a question, to answer based on the paragraph), and of general questions (although the world knowledge is relatively limited).
+## Sample usage:
 
-We are actively working on improving the model, so stay tuned.
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+import torch
 
+tokenizer = AutoTokenizer.from_pretrained('dicta-il/dictalm-7b-instruct')
+model = AutoModelForCausalLM.from_pretrained('dicta-il/dictalm-7b-instruct', trust_remote_code=True).cuda()
+
+model.eval()
+
+with torch.inference_mode():
+    prompt = 'תציע כמה רעיונות לפעילות עם ילדים בני 5:\n'
+    kwargs = dict(
+        inputs=tokenizer(prompt, return_tensors='pt').input_ids.to(model.device),
+        do_sample=True,
+        top_k=50,
+        top_p=0.95,
+        temperature=0.75,
+        max_length=100,
+        min_new_tokens=5
+    )
+    
+    print(tokenizer.batch_decode(model.generate(**kwargs), skip_special_tokens=True))
+```
+
+
+## Citation
+
+If you use DictaLM in your research, please cite ```ADD CITATION HERE```
+
+**BibTeX:**
+
+```ADD BIBTEXT HERE```
+
+## License
+
+Shield: [![CC BY 4.0][cc-by-shield]][cc-by]
 
 This work is licensed under a
 [Creative Commons Attribution 4.0 International License][cc-by].
@@ -23,4 +75,4 @@ This work is licensed under a
 
 [cc-by]: http://creativecommons.org/licenses/by/4.0/
 [cc-by-image]: https://i.creativecommons.org/l/by/4.0/88x31.png
-[cc-by-shield]: https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg
+[cc-by-shield]: https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg