raccoote's picture
Update README.md
0d17570 verified
---
license: apache-2.0
language:
- en
base_model: meta-llama/Meta-Llama-3.1-8B
pipeline_tag: text-generation
library_name: transformers
tags:
- angrybirds
---
# Model Card for Model ID
A fine-tuned version of Llama-3.1-8B, designed to generate Angry Birds levels based on simple text descriptions. The model is trained using the Unsloth library and is optimized to produce game-level designs that can be directly imported into the official Angry Birds game.
## Model Details
### Model Description
This model can be used to generate new levels for the Angry Birds game using simple text inputs. Users can describe elements like "a tall tower made of wood with a pig on top" or "multiple structures with TNT boxes and glass blocks," and the model will create a level design matching the description.
- **Developed by:** Dimitra Pazouli
- **Model type:** Text Generation
- **Language(s) (NLP):** English
- **License:** Apache license 2.0
- **Finetuned from:** Meta-Llama-3.1-8B using the Unsloth library
### 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
The model was fine-tuned using a diverse dataset that includes:
- Existing Angry Birds levels, descriptions, and user-generated content to capture the typical structure, patterns, and elements of the game.
- Additional levels created by us to introduce new variations and elements not found in the original dataset.
- Data augmentation techniques were employed, such as creating variations of the same level with different bird types (e.g., red birds and then yellow birds), to enhance the diversity of the generated outputs.
https://huggingface.co/datasets/raccoote/angry-birds-levels
### 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]