Model Card for Model ID
<!-- Provide a quick summary of what the model is/does. -->
A model aiming to be able to provide coaching for Dota 2 gamers by answering user's questions in a chat format. Improvement and enhancement are still needed.
Model Details
Model Description
<!-- Provide a longer summary of what this model is. -->
This model is trained on mistralai/Mistral-7B-Instruct-v0.2 with instruction-answer dataset about Dota 2 gameplay mechanics.
<!-- **Developed by:** [More Information Needed] -->
- Model type: Transformer-based language model
- Language(s) (NLP): English
- License: MIT
- Finetuned from model [optional]: mistralai/Mistral-7B-Instruct-v0.2
<!--### 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. -->
To give summary of general gameplay mechanics and provide suggestions for gameplay strategy and skill improvement.
Direct Use
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
Provide summary of Dota 2 gameplay in interest.
<!--[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 -->
To give suggestions to Dota 2 players on gameplay strategy.
<!--[More Information Needed]-->
Out-of-Scope Use
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
Gameplay sabotage and abusive chat should not be allowed.
<!-- [More Information Needed] -->
Bias, Risks, and Limitations
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
This model currently is only capable of giving summary of general gameplay mechanics including hero attributes, abilities, talents, maps, runes, building, creeps and items.
The results may not be consistent and accurate. Fact check is still needed.
It is currently not capable of providing strategy suggestion on how to improve player's rank in competitive play.
<!--[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 mentioned above. More improvement and enhancement are still needed.
How to Get Started with the Model
Code example to get started with the model:
import transformers
# Format prompt
message = [
{"role": "user", "content": "Which Strength Hero would you recommend for a Dota 2 beginner?"}
]
tokenizer = AutoTokenizer.from_pretrained("Aiden07/Mistral-7B-Instruct-dota2")
prompt = tokenizer.apply_chat_template(message, add_generation_prompt=True, tokenize=False)
# Create pipeline
pipeline = transformers.pipeline(
"text-generation",
model=new_model,
tokenizer=tokenizer
)
# Generate text
sequences = pipeline(
prompt,
do_sample=True,
temperature=0.7,
top_p=0.9,
num_return_sequences=1,
max_length=200,
)
print(sequences[0]['generated_text'])
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. -->
Dataset used: Aiden07/dota2_instruct_prompt
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
Preprocessing to comply to instruct format:
def create_text_row(instruction, output):
text_row = f"""<s>[INST] {instruction} [/INST] \\n {output} </s>"""
return text_row
Training Hyperparameters
- Training regime: <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
- output_dir="./results",
- num_train_epochs=1,
- per_device_train_batch_size=4,
- gradient_accumulation_steps=1,
- optim="paged_adamw_32bit",
- save_steps=25,
- logging_steps=25,
- learning_rate=2e-4,
- weight_decay=0.001,
- fp16=False,
- bf16=False,
- max_grad_norm=0.3,
- max_steps=-1,
- warmup_ratio=0.03,
- group_by_length=True,
- lr_scheduler_type="constant"
<!-- #### 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] -->
<!-- ## Environmental Impact -->
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
<!-- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
- **Hardware Type:** [More Information Needed]
- **Hours used:** [More Information Needed]
- **Cloud Provider:** [More Information Needed]
- **Compute Region:** [More Information Needed]
- **Carbon Emitted:** [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]
## Glossary [optional]
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
<!-- [More Information Needed]
## More Information [optional]
[More Information Needed]
## Model Card Authors [optional]
[More Information Needed]
## Model Card Contact
[More Information Needed] -->