Update README.md

README.md

@@ -1,3 +1,56 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+license_link: https://huggingface.co/Qwen/Qwen2.5-7B-Instruct-1M/resolve/main/LICENSE
+language:
+- en
+pipeline_tag: text-generation
+---
+
+# Qwen 2.5 7B Instruct 1M
+
+**Original Author** : [Qwen](https://huggingface.co/Qwen).<br>
+**Model Owner**: [Qwen](https://huggingface.co/Qwen).<br>
+**Original Repository**: [Qwen/Qwen2.5-7B-Instruct-1M](https://huggingface.co/Qwen/Qwen2.5-7B-Instruct-1M).<br>
+**Conversion Tool**: [llama.cpp](https://github.com/ggerganov/llama.cpp).
+
+## Description
+
+This repo contains Qwen2.5-7B-Instruct-1M model in gguf with [NLQuery](https://github.com/Emreerdog/mbase_nlquery) configuration applied to the gguf metadata so that it can be leveraged by the [NLQuery](https://github.com/Emreerdog/mbase_nlquery) Text-to-SQL engine.
+
+## Conversion Process
+Original model [Qwen](https://huggingface.co/Qwen) safetensors are converted
+using the [llama.cpp](https://github.com/ggerganov/llama.cpp) model conversion script.
+
+The default configuration applied during the conversion process. In other words, neither the imatrix applied or the GGUF parameters 
+altered.
+
+Then, [NLQuery system prompt](https://github.com/Emreerdog/mbase_nlquery/blob/main/system_prompt.txt) is cooked into the gguf metadata of the model file.
+
+For detailed information about the conversion process: [Converting to GGUF](https://docs.mbasesoftware.com/inference/info-reference/gguf-files.html#converting-to-gguf)
+
+For detailed information about the NLQuery prompt cooking: [NLQuery Prompt Cook](https://github.com/Emreerdog/mbase_nlquery?tab=readme-ov-file#prompt-cooking)
+
+## MBASE GGUF Documentation
+
+For general information about GGUF files: [About GGUF Files](https://docs.mbasesoftware.com/inference/info-reference/gguf-files.html)
+
+## Chat Template
+
+```
+<|im_start|>{system_prompt}
+<|im_end|>
+<|im_start|>{user_prompt}
+<|im_end|>
+<|im_start|>{assistant_response}
+<|im_end|>
+```
+
+## Disclaimer
+
+MBASE Software Corporation is a software company officially registered as (MBASE Yazılım A.Ş.) in Turkey (https://www.mbasesoftware.com). Throughout this document, references to MBASE Software Corporation or MBASE refer to the (MBASE Yazılım A.Ş.)
+
+MBASE is not the creator, originator, or owner of the model featured in this repository. This model is created and provided by third parties. MBASE does not endorse, support, or guarantee the completeness, accuracy, or reliability of the model or its outputs.
+
+You understand that the model can generate content that may be offensive, harmful, inaccurate, inappropriate, or deceptive. Responsibility for the model and its outputs lies solely with the entity or individual who created and provided the model. MBASE does not monitor or control the model's outputs and disclaims any liability arising from its use.
+
+MBASE provides no warranties regarding the accuracy, reliability, or fitness of the model for any particular purpose. Additionally, MBASE disclaims any guarantees that the model will operate without errors, interruptions, viruses, or other issues. You are solely responsible for any consequences resulting from the use or access of this model, including any damage caused by downloading or utilizing it.