Create README.md

README.md

@@ -0,0 +1,40 @@
+---
+datasets:
+- msaad02/formatted-ss-cleaned-brockport-qa
+language:
+- en
+pipeline_tag: text-generation
+---
+
+# BrockportGPT LLaMA2 Finetune
+
+> This is a quantized version of the original model, found at "msaad02/llama2_7b_brockportgpt"
+
+This model is part of my thesis to make a question-answering bot for SUNY Brockport. The data used for finetuning is a subset of the question database I generated, and is also available on my huggingface account.
+
+For more information, see my [github repo](https://github.com/msaad02/honors-thesis) for the project.
+
+## Examples
+
+>Are SAT scores required?
+>>SAT scores are not required for admission, but test scores are used as part of Brockport's holistic review process to make admissions decisions.
+
+>Who can I contact for help with financial aid?
+>>You can contact the financial aid office at SUNY Brockport for assistance with financial aid. They are available to answer any questions and help you navigate the financial aid process.
+
+
+## Prompting
+
+This prompting style is what was used for finetuning:
+
+>Below is an inquiry related to SUNY Brockport - from academics, admissions, and faculty support to student life. Prioritize accuracy and brevity.
+>
+>\### Instruction:\
+>{question}
+>
+>\### Response:\
+>{response}
+
+## Usage
+
+To run this model, I suggest using the following code to load the model in 4-bit and build a pipeline, which implements the correct prompt formatting