Upload README.md

README.md

@@ -1,3 +1,41 @@
----
-license: apache-2.0
----
+---
+license: other
+---
+
+# Model Card for Model ID
+
+<!-- Provide a quick summary of what the model is/does. -->
+
+**dragon-yi-answer-tool** is a quantized version of DRAGON Yi 6B, with 4_K_M GGUF quantization, providing a fast, small inference implementation for use on CPUs.  
+
+[**dragon-yi-6b**](https://huggingface.co/llmware/dragon-yi-6b-v0) is a fact-based question-answering model, optimized for complex business documents.  
+
+To pull the model via API:  
+
+    from huggingface_hub import snapshot_download           
+    snapshot_download("llmware/dragon-yi-answer-tool", local_dir="/path/on/your/machine/", local_dir_use_symlinks=False)  
+    
+
+Load in your favorite GGUF inference engine, or try with llmware as follows:
+
+    from llmware.models import ModelCatalog  
+    model = ModelCatalog().load_model("dragon-yi-answer-tool")            
+    response = model.inference(query, add_context=text_sample)  
+
+Note: please review [**config.json**](https://huggingface.co/llmware/dragon-yi-answer-tool/blob/main/config.json) in the repository for prompt wrapping information, details on the model, and full test set.  
+
+
+### Model Description
+
+<!-- Provide a longer summary of what this model is. -->
+
+- **Developed by:** llmware
+- **Model type:** GGUF 
+- **Language(s) (NLP):** English
+- **License:** Yi Community License
+- **Quantized from model:** [llmware/dragon-yi](https://huggingface.co/llmware/dragon-yi-6b-v0/)
+  
+
+## Model Card Contact
+
+Darren Oberst & llmware team