251 lines
6.9 KiB
Markdown
251 lines
6.9 KiB
Markdown
---
|
|
library_name: transformers
|
|
tags:
|
|
- trl
|
|
- sft
|
|
datasets:
|
|
- tau/commonsense_qa
|
|
base_model:
|
|
- BAAI/Aquila-135M-Instruct
|
|
license: apache-2.0
|
|
---
|
|
|
|
# Model Card for Model ID
|
|
|
|
<!-- Provide a quick summary of what the model is/does. -->
|
|
|
|
|
|
|
|
## 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:** Chakrabhuana Vishnu Deva
|
|
- **Funded by [optional]:** [More Information Needed]
|
|
- **Shared by [optional]:** [More Information Needed]
|
|
- **Model type:** Causal Language Model
|
|
- **Language(s) (NLP):** English
|
|
- **License:** Apache 2.0
|
|
- **Finetuned from model [optional]:** BAAI/Aquila-135M-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. -->
|
|
|
|
The model is designed to answer multiple-choice questions. It is fine-tuned on the `tau/commonsense_qa` dataset.
|
|
|
|
### 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.
|
|
|
|
```python
|
|
import torch
|
|
from transformers import AutoTokenizer, AutoModelForCausalLM
|
|
|
|
model_id = "RinKana/aquila-135m-csqa" # Note: replace with your exact repo ID if different
|
|
|
|
tokenizer = AutoTokenizer.from_pretrained(model_id, trust_remote_code=True)
|
|
model = AutoModelForCausalLM.from_pretrained(model_id, trust_remote_code=True, device_map="auto")
|
|
|
|
question = "What is the capital of France?"
|
|
options = "A. London\nB. Paris\nC. Berlin\nD. Madrid\nE. Rome"
|
|
|
|
user_prompt = (
|
|
"Answer the following multiple-choice question.\n\n"
|
|
f"Question: {question}\n"
|
|
f"Options:\n{options}\n\n"
|
|
"Answer with ONLY the letter (A, B, C, D, or E)."
|
|
)
|
|
|
|
messages = [{"role": "user", "content": user_prompt}]
|
|
prompt = tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
|
|
inputs = tokenizer(prompt, return_tensors="pt").to(model.device)
|
|
|
|
with torch.no_grad():
|
|
outputs = model.generate(
|
|
**inputs,
|
|
max_new_tokens=5,
|
|
temperature=0.0,
|
|
do_sample=False,
|
|
)
|
|
|
|
input_length = inputs["input_ids"].shape[1]
|
|
response = tokenizer.decode(outputs[0][input_length:], skip_special_tokens=True).strip()
|
|
print(f"Predicted Answer: {response}")
|
|
```
|
|
|
|
## 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. -->
|
|
|
|
The model was trained on the [tau/commonsense_qa](https://huggingface.co/datasets/tau/commonsense_qa) dataset.
|
|
|
|
### 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
|
|
|
|
The model was trained with the following hyperparameters:
|
|
- **max_length:** 256
|
|
- **per_device_train_batch_size:** 16
|
|
- **per_device_eval_batch_size:** 16
|
|
- **gradient_accumulation_steps:** 2
|
|
- **num_train_epochs:** 3
|
|
- **learning_rate:** 2e-5
|
|
- **Training regime:** bf16 mixed precision <!--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
|
|
|
|
| Epoch | Training Loss | Validation Loss | Entropy | Num Tokens | Mean Token Accuracy |
|
|
|---|---|---|---|---|---|
|
|
| 1 | 1.164672 | 1.156044 | 1.286664 | 864431.000000 | 0.786455 |
|
|
| 2 | 1.125324 | 1.123461 | 1.223981 | 1728862.000000 | 0.798904 |
|
|
| 3 | 1.110953 | 1.120729 | 1.214477 | 2593293.000000 | 0.798789 |
|
|
|
|
#### 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] |