Create README.md

A nearly useless finetuned version of Mixtral7b

README.md

@@ -0,0 +1,35 @@
+language: en
+tags:
+- snomed-ct
+- text-generation
+---
+
+# My Model Name
+
+## Model description
+This is a text generation model for SNOMED-CT. As it is text-generation, it is prone to hallucination and should not be used for any kind of production purpose but it was fun to build. It is based on Mixtral7b and was fine-tuned on a part of the SNOMED-CT corpus then tested against a gold-standard.
+
+## How to use
+Provide code snippets on how to use your model.
+
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+model_name = "{username}/{model_id}"
+model = AutoModelForCausalLM.from_pretrained(model_name)
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+```
+
+Model Performance
+Accuracy: {metrics["0"]}
+Precision: {metrics["0"]}
+Recall: {metrics["0"]}
+
+ParameterName	SNOMEDCode	ExtractedSNOMEDNumbers	CorrectPrediction
+*Heart rate	    364075005	3222222	                False
+
+Limitations and bias
+It is really low grade but I had fun building it so have pushed it up
+
+Acknowledgments
+Thanks to the Mixtral AI team for creating the base model for this one.