jakeboggs
/

MTG-Llama

@@ -4,163 +4,48 @@ datasets:
 - jakeboggs/MTG-Eval
 ---
-# Model Card for Model ID
-MTG Llama is a QLoRA fine-tuned Llama 3 model on the [MTG Eval](https://huggingface.co/datasets/jakeboggs/MTG-Eval) dataset.
 ## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **Developed by:** Jake Boggs
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model :** NousResearch/Meta-Llama-3-8B-Instruct
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]

 - jakeboggs/MTG-Eval
 ---
+# Model Card for MTG-Llama: Fine-Tuned Model for Magic: The Gathering
 ## Model Details
+**Model Name:** MTG-Llama
+**Version:** 1.0
+**Base Model:** Llama 3 8B Instruct
+**Fine-Tuning Dataset:** MTG-Eval
+**Author:** Jake Boggs
+## Model Description
+MTG-Llama is a fine-tuned version of Llama 3 8B Instruct, tailored specifically for understanding and generating responses related to  Magic: The Gathering (MTG). The model has been fine-tuned using a custom dataset, MTG-Eval, which includes question-answer pairs covering card descriptions, rules questions, and card interactions.
+## Intended Use
+MTG-Llama is designed to assist users with:
+- Generating deck construction ideas.
+- Answering in-game rules questions.
+- Understanding card interactions and abilities.
+## Training Data
+The fine-tuning dataset, MTG-Eval, consists of 80,032 question-answer pairs generated synthetically. The dataset is categorized into:
+- **Card Descriptions:** 26,702 examples
+- **Rules Questions:** 27,104 examples
+- **Card Interactions:** 26,226 examples
+The data was sourced from the MTGJSON project and the Commander Spellbook combo database, reformatted into natural language question-answer pairs using ChatGPT 3.5.
+## Training Procedure
+The model was fine-tuned using QLoRA with the following hyperparameters:
+- **r:** 64
+- **alpha:** 32
+- **Steps:** 75
+## Acknowledgments
+Thanks to the team at Commander Spellbook for generously sharing their dataset, without which this research would not be possible. All generated data is unofficial Fan Content permitted under the Fan Content Policy. Not approved/endorsed by Wizards. Portions of the materials used are property of Wizards of the Coast. ©Wizards of the Coast LLC.
+## Resources
+- **Dataset:** [MTG-Eval on HuggingFace](https://huggingface.co/datasets/jakeboggs/MTG-Eval)
+- **Training Code:** [GitHub Repository](https://github.com/JakeBoggs/Large-Language-Models-for-Magic-the-Gathering)