Update README.md

README.md

@@ -1,3 +1,66 @@
 ---
 license: apache-2.0
+pipeline_tag: text-generation
+language:
+  - en
+  - he
+tags:
+- instruction-tuned
+base_model: dicta-il/dictalm2.0
+inference:
+  parameters:
+    temperature: 0.7
 ---
+
+[<img src="https://i.ibb.co/5Lbwyr1/dicta-logo.jpg" width="300px"/>](https://dicta.org.il)
+
+
+# Model Card for DictaLM-2.0-Instruct
+
+The DictaLM-2.0-Instruct Large Language Model (LLM) is an instruct fine-tuned version of the [DictaLM-2.0](https://huggingface.co/dicta-il/dictalm2.0) generative model using a variety of conversation datasets.
+
+For full details of this model please read our [release blog post](https://dicta.org.il/dicta-lm).
+
+This is the instruct-tuned model designed for chat in the GGUF format for use with [LM Studio](https://lmstudio.ai/) or [llama.cpp](https://github.com/ggerganov/llama.cpp). You can try the model out on a live demo [here](https://huggingface.co/spaces/dicta-il/dictalm2.0-instruct-demo).
+
+There are two versions available - float16 precision (`*.F16.gguf`) and 4-bit quantized precision (`*.Q4_K_M.gguf`).
+
+You can view and access the full collection of base/instruct unquantized/quantized versions of `DictaLM-2.0` [here](https://huggingface.co/collections/dicta-il/dicta-lm-20-collection-661bbda397df671e4a430c27).
+
+## Instruction format
+
+In order to leverage instruction fine-tuning, your prompt should be surrounded by `[INST]` and `[/INST]` tokens followed by a line break. The very first instruction should begin with a begin of sentence id. The next instructions should not. The assistant generation will be ended by the end-of-sentence token id.
+
+E.g.
+```
+text = """<s>[INST] איזה רוטב אהוב עליך? [/INST]
+טוב, אני די מחבב כמה טיפות מיץ לימון סחוט טרי. זה מוסיף בדיוק את הכמות הנכונה של טעם חמצמץ לכל מה שאני מבשל במטבח!</s>[INST] האם יש לך מתכונים למיונז? [/INST]"
+```
+
+This format is available as a [chat template](https://huggingface.co/docs/transformers/main/chat_templating) via the `apply_chat_template()` method:
+
+## Using with LM Studio
+
+When using with LM Studio, just search the hub for "dictalm2.0-instruct-GGUF", and the model in both precisions should appear. 
+
+Make sure to set the chat template correctly - initialize from the `mistral-instruct` template, and add a `\n` in the suffix box, like here:
+
+<img src="https://i.ibb.co/D9MVgK2/lmstudio-dlm-template.png" width="400px" />
+
+## Model Architecture
+
+DictaLM-2.0-Instruct follows the [Zephyr-7B-beta](https://huggingface.co/HuggingFaceH4/zephyr-7b-beta) recipe for fine-tuning an instruct model, with an extended instruct dataset for Hebrew.
+
+## Limitations
+
+The DictaLM 2.0 Instruct model is a demonstration that the base model can be fine-tuned to achieve compelling performance. 
+It does not have any moderation mechanisms. We're looking forward to engaging with the community on ways to
+make the model finely respect guardrails, allowing for deployment in environments requiring moderated outputs.
+
+## Citation
+
+If you use this model, please cite:
+
+```bibtex
+[Will be added soon]
+```