初始化项目,由ModelHub XC社区提供模型
Model: ratnasekhar/earnings-copilot-phi3-merged Source: Original Platform
This commit is contained in:
35
.gitattributes
vendored
Normal file
35
.gitattributes
vendored
Normal file
@@ -0,0 +1,35 @@
|
||||
*.7z filter=lfs diff=lfs merge=lfs -text
|
||||
*.arrow filter=lfs diff=lfs merge=lfs -text
|
||||
*.bin filter=lfs diff=lfs merge=lfs -text
|
||||
*.bz2 filter=lfs diff=lfs merge=lfs -text
|
||||
*.ckpt filter=lfs diff=lfs merge=lfs -text
|
||||
*.ftz filter=lfs diff=lfs merge=lfs -text
|
||||
*.gz filter=lfs diff=lfs merge=lfs -text
|
||||
*.h5 filter=lfs diff=lfs merge=lfs -text
|
||||
*.joblib filter=lfs diff=lfs merge=lfs -text
|
||||
*.lfs.* filter=lfs diff=lfs merge=lfs -text
|
||||
*.mlmodel filter=lfs diff=lfs merge=lfs -text
|
||||
*.model filter=lfs diff=lfs merge=lfs -text
|
||||
*.msgpack filter=lfs diff=lfs merge=lfs -text
|
||||
*.npy filter=lfs diff=lfs merge=lfs -text
|
||||
*.npz filter=lfs diff=lfs merge=lfs -text
|
||||
*.onnx filter=lfs diff=lfs merge=lfs -text
|
||||
*.ot filter=lfs diff=lfs merge=lfs -text
|
||||
*.parquet filter=lfs diff=lfs merge=lfs -text
|
||||
*.pb filter=lfs diff=lfs merge=lfs -text
|
||||
*.pickle filter=lfs diff=lfs merge=lfs -text
|
||||
*.pkl filter=lfs diff=lfs merge=lfs -text
|
||||
*.pt filter=lfs diff=lfs merge=lfs -text
|
||||
*.pth filter=lfs diff=lfs merge=lfs -text
|
||||
*.rar filter=lfs diff=lfs merge=lfs -text
|
||||
*.safetensors filter=lfs diff=lfs merge=lfs -text
|
||||
saved_model/**/* filter=lfs diff=lfs merge=lfs -text
|
||||
*.tar.* filter=lfs diff=lfs merge=lfs -text
|
||||
*.tar filter=lfs diff=lfs merge=lfs -text
|
||||
*.tflite filter=lfs diff=lfs merge=lfs -text
|
||||
*.tgz filter=lfs diff=lfs merge=lfs -text
|
||||
*.wasm filter=lfs diff=lfs merge=lfs -text
|
||||
*.xz filter=lfs diff=lfs merge=lfs -text
|
||||
*.zip filter=lfs diff=lfs merge=lfs -text
|
||||
*.zst filter=lfs diff=lfs merge=lfs -text
|
||||
*tfevents* filter=lfs diff=lfs merge=lfs -text
|
||||
128
README.md
Normal file
128
README.md
Normal file
@@ -0,0 +1,128 @@
|
||||
---
|
||||
language: en
|
||||
license: mit
|
||||
base_model: microsoft/Phi-3.5-mini-instruct
|
||||
tags:
|
||||
- finance
|
||||
- sec-filings
|
||||
- qlora
|
||||
- peft
|
||||
- kpi-extraction
|
||||
- financial-analysis
|
||||
pipeline_tag: text-generation
|
||||
---
|
||||
|
||||
# Earnings Intelligence Copilot — Fine-tuned Phi-3.5-mini (Merged)
|
||||
|
||||
A QLoRA fine-tuned and merged version of Phi-3.5-mini-instruct for structured KPI extraction from SEC filings.
|
||||
Part of the [Earnings Intelligence Copilot](https://github.com/ratnasekhar/earnings-copilot) — a multi-agent
|
||||
system that ingests SEC filings, extracts KPIs, and generates citation-grounded investment memos.
|
||||
|
||||
## What it does
|
||||
|
||||
- Extracts financial KPIs (Revenue, Gross Margin, Operating Income, EPS, Free Cash Flow) from SEC filing chunks as structured JSON
|
||||
- Returns `{"confidence": "UNVERIFIABLE"}` instead of hallucinating when data is not present
|
||||
- Always includes a `source_quote` field grounding every answer in the original filing text
|
||||
|
||||
## Model Details
|
||||
|
||||
| Property | Value |
|
||||
|---|---|
|
||||
| Base model | microsoft/Phi-3.5-mini-instruct |
|
||||
| Fine-tuning method | QLoRA (4-bit NF4 quantization) |
|
||||
| LoRA rank | r=16, alpha=32 |
|
||||
| Target modules | q_proj, v_proj, k_proj, o_proj |
|
||||
| Training examples | 619 balanced examples (50% HIGH / 50% UNVERIFIABLE) |
|
||||
| Data source | 10-K and 10-Q filings, 20 S&P 500 companies (2020-2024) |
|
||||
| Training hardware | Kaggle T4 GPU (~75 minutes) |
|
||||
| Model type | Full merged model (adapter + base combined) |
|
||||
|
||||
## Usage
|
||||
```python
|
||||
from transformers import AutoTokenizer, AutoModelForCausalLM
|
||||
import torch
|
||||
|
||||
tokenizer = AutoTokenizer.from_pretrained(
|
||||
"ratnasekhar/earnings-copilot-phi3-merged",
|
||||
trust_remote_code=True
|
||||
)
|
||||
model = AutoModelForCausalLM.from_pretrained(
|
||||
"ratnasekhar/earnings-copilot-phi3-merged",
|
||||
dtype=torch.float16,
|
||||
device_map="auto",
|
||||
trust_remote_code=True,
|
||||
attn_implementation="eager"
|
||||
)
|
||||
model.eval()
|
||||
|
||||
chunk = "Net sales for Q1 FY2024 were $119.6 billion, an increase of 2% compared to Q1 FY2023."
|
||||
prompt = (
|
||||
"<|user|>\n"
|
||||
"You are a financial KPI extraction model. Extract metrics as JSON. "
|
||||
"Output {\"confidence\": \"UNVERIFIABLE\"} if not found. Never invent numbers.\n\n"
|
||||
"Filing chunk:\n" + chunk + "\n\n"
|
||||
"Extract: What was total revenue and its YoY change?<|end|>\n"
|
||||
"<|assistant|>\n"
|
||||
)
|
||||
|
||||
inputs = tokenizer(prompt, return_tensors="pt").to("cuda")
|
||||
with torch.no_grad():
|
||||
out = model.generate(
|
||||
**inputs,
|
||||
max_new_tokens=150,
|
||||
do_sample=False,
|
||||
pad_token_id=tokenizer.eos_token_id,
|
||||
use_cache=False
|
||||
)
|
||||
print(tokenizer.decode(out[0][inputs["input_ids"].shape[1]:], skip_special_tokens=True))
|
||||
```
|
||||
|
||||
## Example Outputs
|
||||
|
||||
**When data IS present:**
|
||||
```json
|
||||
{
|
||||
"metric": "Total Revenue",
|
||||
"value": "$119.6 billion",
|
||||
"unit": "Billion",
|
||||
"period": "Q1 FY2024",
|
||||
"yoy_change": "+2%",
|
||||
"source_quote": "Net sales for Q1 FY2024 were $119.6 billion",
|
||||
"confidence": "HIGH"
|
||||
}
|
||||
```
|
||||
|
||||
**When data is NOT present:**
|
||||
```json
|
||||
{
|
||||
"confidence": "UNVERIFIABLE",
|
||||
"reason": "The chunk does not contain any specific revenue figures."
|
||||
}
|
||||
```
|
||||
|
||||
## Key Design Decision — Class Balance
|
||||
|
||||
Raw LLM-generated training data had 93% UNVERIFIABLE examples. Training on this
|
||||
imbalanced data would cause the model to always refuse. We deliberately resampled
|
||||
to 50/50 HIGH/UNVERIFIABLE to teach both behaviors equally — this is the core
|
||||
fine-tuning contribution of the project.
|
||||
|
||||
## Related Models
|
||||
|
||||
| Model | Description |
|
||||
|---|---|
|
||||
| [ratnasekhar/earnings-copilot-mistral-7b](https://huggingface.co/ratnasekhar/earnings-copilot-mistral-7b) | Mistral-7B LoRA adapter (larger, higher quality) |
|
||||
| ratnasekhar/earnings-copilot-phi3-merged | Phi-3.5-mini merged model (this model, deployable) |
|
||||
|
||||
## System Architecture
|
||||
```
|
||||
SEC Filings (220 filings, 20 S&P 500 tickers)
|
||||
↓
|
||||
Qdrant Cloud (2,464 financial table chunks)
|
||||
↓
|
||||
Phi-3.5-mini — this model (KPI extraction)
|
||||
↓
|
||||
Verification Agent (cross-checks every number)
|
||||
↓
|
||||
Citation-grounded Investment Memo
|
||||
```
|
||||
13
added_tokens.json
Normal file
13
added_tokens.json
Normal file
@@ -0,0 +1,13 @@
|
||||
{
|
||||
"<|endoftext|>": 32000,
|
||||
"<|assistant|>": 32001,
|
||||
"<|placeholder1|>": 32002,
|
||||
"<|placeholder2|>": 32003,
|
||||
"<|placeholder3|>": 32004,
|
||||
"<|placeholder4|>": 32005,
|
||||
"<|system|>": 32006,
|
||||
"<|end|>": 32007,
|
||||
"<|placeholder5|>": 32008,
|
||||
"<|placeholder6|>": 32009,
|
||||
"<|user|>": 32010
|
||||
}
|
||||
8
chat_template.jinja
Normal file
8
chat_template.jinja
Normal file
@@ -0,0 +1,8 @@
|
||||
{% for message in messages %}{% if message['role'] == 'system' and message['content'] %}{{'<|system|>
|
||||
' + message['content'] + '<|end|>
|
||||
'}}{% elif message['role'] == 'user' %}{{'<|user|>
|
||||
' + message['content'] + '<|end|>
|
||||
'}}{% elif message['role'] == 'assistant' %}{{'<|assistant|>
|
||||
' + message['content'] + '<|end|>
|
||||
'}}{% endif %}{% endfor %}{% if add_generation_prompt %}{{ '<|assistant|>
|
||||
' }}{% else %}{{ eos_token }}{% endif %}
|
||||
136
config.json
Normal file
136
config.json
Normal file
@@ -0,0 +1,136 @@
|
||||
{
|
||||
"architectures": [
|
||||
"Phi3ForCausalLM"
|
||||
],
|
||||
"attention_bias": false,
|
||||
"attention_dropout": 0.0,
|
||||
"bos_token_id": 1,
|
||||
"dtype": "float16",
|
||||
"embd_pdrop": 0.0,
|
||||
"eos_token_id": 32000,
|
||||
"hidden_act": "silu",
|
||||
"hidden_size": 3072,
|
||||
"initializer_range": 0.02,
|
||||
"intermediate_size": 8192,
|
||||
"max_position_embeddings": 131072,
|
||||
"model_type": "phi3",
|
||||
"num_attention_heads": 32,
|
||||
"num_hidden_layers": 32,
|
||||
"num_key_value_heads": 32,
|
||||
"original_max_position_embeddings": 4096,
|
||||
"pad_token_id": 32000,
|
||||
"resid_pdrop": 0.0,
|
||||
"rms_norm_eps": 1e-05,
|
||||
"rope_parameters": {
|
||||
"long_factor": [
|
||||
1.0800000429153442,
|
||||
1.1100000143051147,
|
||||
1.1399999856948853,
|
||||
1.340000033378601,
|
||||
1.5899999141693115,
|
||||
1.600000023841858,
|
||||
1.6200000047683716,
|
||||
2.620000123977661,
|
||||
3.2300000190734863,
|
||||
3.2300000190734863,
|
||||
4.789999961853027,
|
||||
7.400000095367432,
|
||||
7.700000286102295,
|
||||
9.09000015258789,
|
||||
12.199999809265137,
|
||||
17.670000076293945,
|
||||
24.46000099182129,
|
||||
28.57000160217285,
|
||||
30.420001983642578,
|
||||
30.840002059936523,
|
||||
32.590003967285156,
|
||||
32.93000411987305,
|
||||
42.320003509521484,
|
||||
44.96000289916992,
|
||||
50.340003967285156,
|
||||
50.45000457763672,
|
||||
57.55000305175781,
|
||||
57.93000411987305,
|
||||
58.21000289916992,
|
||||
60.1400032043457,
|
||||
62.61000442504883,
|
||||
62.62000274658203,
|
||||
62.71000289916992,
|
||||
63.1400032043457,
|
||||
63.1400032043457,
|
||||
63.77000427246094,
|
||||
63.93000411987305,
|
||||
63.96000289916992,
|
||||
63.970001220703125,
|
||||
64.02999877929688,
|
||||
64.06999969482422,
|
||||
64.08000183105469,
|
||||
64.12000274658203,
|
||||
64.41000366210938,
|
||||
64.4800033569336,
|
||||
64.51000213623047,
|
||||
64.52999877929688,
|
||||
64.83999633789062
|
||||
],
|
||||
"original_max_position_embeddings": 4096,
|
||||
"rope_theta": 10000.0,
|
||||
"rope_type": "longrope",
|
||||
"short_factor": [
|
||||
1.0,
|
||||
1.0199999809265137,
|
||||
1.0299999713897705,
|
||||
1.0299999713897705,
|
||||
1.0499999523162842,
|
||||
1.0499999523162842,
|
||||
1.0499999523162842,
|
||||
1.0499999523162842,
|
||||
1.0499999523162842,
|
||||
1.0699999332427979,
|
||||
1.0999999046325684,
|
||||
1.1099998950958252,
|
||||
1.1599998474121094,
|
||||
1.1599998474121094,
|
||||
1.1699998378753662,
|
||||
1.2899998426437378,
|
||||
1.339999794960022,
|
||||
1.679999828338623,
|
||||
1.7899998426437378,
|
||||
1.8199998140335083,
|
||||
1.8499997854232788,
|
||||
1.8799997568130493,
|
||||
1.9099997282028198,
|
||||
1.9399996995925903,
|
||||
1.9899996519088745,
|
||||
2.0199997425079346,
|
||||
2.0199997425079346,
|
||||
2.0199997425079346,
|
||||
2.0199997425079346,
|
||||
2.0199997425079346,
|
||||
2.0199997425079346,
|
||||
2.0299997329711914,
|
||||
2.0299997329711914,
|
||||
2.0299997329711914,
|
||||
2.0299997329711914,
|
||||
2.0299997329711914,
|
||||
2.0299997329711914,
|
||||
2.0299997329711914,
|
||||
2.0299997329711914,
|
||||
2.0299997329711914,
|
||||
2.0799996852874756,
|
||||
2.0899996757507324,
|
||||
2.189999580383301,
|
||||
2.2199995517730713,
|
||||
2.5899994373321533,
|
||||
2.729999542236328,
|
||||
2.749999523162842,
|
||||
2.8399994373321533
|
||||
],
|
||||
"type": "longrope"
|
||||
},
|
||||
"rope_theta": 10000.0,
|
||||
"sliding_window": 262144,
|
||||
"tie_word_embeddings": false,
|
||||
"transformers_version": "5.2.0",
|
||||
"use_cache": true,
|
||||
"vocab_size": 32064
|
||||
}
|
||||
227
configuration_phi3.py
Normal file
227
configuration_phi3.py
Normal file
@@ -0,0 +1,227 @@
|
||||
# coding=utf-8
|
||||
# Copyright 2024 Microsoft and the HuggingFace Inc. team. All rights reserved.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
""" Phi-3 model configuration"""
|
||||
|
||||
|
||||
from transformers.configuration_utils import PretrainedConfig
|
||||
from transformers.utils import logging
|
||||
|
||||
|
||||
logger = logging.get_logger(__name__)
|
||||
|
||||
PHI3_PRETRAINED_CONFIG_ARCHIVE_MAP = {
|
||||
"microsoft/Phi-3-mini-4k-instruct": "https://huggingface.co/microsoft/Phi-3-mini-4k-instruct/resolve/main/config.json",
|
||||
"microsoft/Phi-3-mini-128k-instruct": "https://huggingface.co/microsoft/Phi-3-mini-128k-instruct/resolve/main/config.json",
|
||||
}
|
||||
|
||||
|
||||
class Phi3Config(PretrainedConfig):
|
||||
r"""
|
||||
This is the configuration class to store the configuration of a [`Phi3Model`]. It is used to instantiate a Phi-3
|
||||
model according to the specified arguments, defining the model architecture. Instantiating a configuration with the
|
||||
defaults will yield a similar configuration to that of the
|
||||
[microsoft/Phi-3-mini-4k-instruct](https://huggingface.co/microsoft/Phi-3-mini-4k-instruct).
|
||||
|
||||
Configuration objects inherit from [`PretrainedConfig`] and can be used to control the model outputs. Read the
|
||||
documentation from [`PretrainedConfig`] for more information.
|
||||
|
||||
Args:
|
||||
vocab_size (`int`, *optional*, defaults to 32064):
|
||||
Vocabulary size of the Phi-3 model. Defines the number of different tokens that can be represented by the
|
||||
`inputs_ids` passed when calling [`Phi3Model`].
|
||||
hidden_size (`int`, *optional*, defaults to 3072):
|
||||
Dimension of the hidden representations.
|
||||
intermediate_size (`int`, *optional*, defaults to 8192):
|
||||
Dimension of the MLP representations.
|
||||
num_hidden_layers (`int`, *optional*, defaults to 32):
|
||||
Number of hidden layers in the Transformer decoder.
|
||||
num_attention_heads (`int`, *optional*, defaults to 32):
|
||||
Number of attention heads for each attention layer in the Transformer decoder.
|
||||
num_key_value_heads (`int`, *optional*):
|
||||
This is the number of key_value heads that should be used to implement Grouped Query Attention. If
|
||||
`num_key_value_heads=num_attention_heads`, the model will use Multi Head Attention (MHA), if
|
||||
`num_key_value_heads=1 the model will use Multi Query Attention (MQA) otherwise GQA is used. When
|
||||
converting a multi-head checkpoint to a GQA checkpoint, each group key and value head should be constructed
|
||||
by meanpooling all the original heads within that group. For more details checkout [this
|
||||
paper](https://arxiv.org/pdf/2305.13245.pdf). If it is not specified, will default to
|
||||
`num_attention_heads`.
|
||||
resid_pdrop (`float`, *optional*, defaults to 0.0):
|
||||
Dropout probability for mlp outputs.
|
||||
embd_pdrop (`int`, *optional*, defaults to 0.0):
|
||||
The dropout ratio for the embeddings.
|
||||
attention_dropout (`float`, *optional*, defaults to 0.0):
|
||||
The dropout ratio after computing the attention scores.
|
||||
hidden_act (`str` or `function`, *optional*, defaults to `"silu"`):
|
||||
The non-linear activation function (function or string) in the decoder.
|
||||
max_position_embeddings (`int`, *optional*, defaults to 4096):
|
||||
The maximum sequence length that this model might ever be used with.
|
||||
original_max_position_embeddings (`int`, *optional*, defaults to 4096):
|
||||
The maximum sequence length that this model was trained with. This is used to determine the size of the
|
||||
original RoPE embeddings when using long scaling.
|
||||
initializer_range (`float`, *optional*, defaults to 0.02):
|
||||
The standard deviation of the truncated_normal_initializer for initializing all weight matrices.
|
||||
rms_norm_eps (`float`, *optional*, defaults to 1e-05):
|
||||
The epsilon value used for the RMSNorm.
|
||||
use_cache (`bool`, *optional*, defaults to `True`):
|
||||
Whether or not the model should return the last key/values attentions (not used by all models). Only
|
||||
relevant if `config.is_decoder=True`. Whether to tie weight embeddings or not.
|
||||
tie_word_embeddings (`bool`, *optional*, defaults to `False`):
|
||||
Whether to tie weight embeddings
|
||||
rope_theta (`float`, *optional*, defaults to 10000.0):
|
||||
The base period of the RoPE embeddings.
|
||||
rope_scaling (`dict`, *optional*):
|
||||
The scaling strategy for the RoPE embeddings. If `None`, no scaling is applied. If a dictionary, it must
|
||||
contain the following keys: `type`, `short_factor` and `long_factor`. The `type` must be `longrope` and
|
||||
the `short_factor` and `long_factor` must be lists of numbers with the same length as the hidden size
|
||||
divided by the number of attention heads divided by 2.
|
||||
bos_token_id (`int`, *optional*, defaults to 1):
|
||||
The id of the "beginning-of-sequence" token.
|
||||
eos_token_id (`int`, *optional*, defaults to 32000):
|
||||
The id of the "end-of-sequence" token.
|
||||
pad_token_id (`int`, *optional*, defaults to 32000):
|
||||
The id of the padding token.
|
||||
sliding_window (`int`, *optional*):
|
||||
Sliding window attention window size. If `None`, no sliding window is applied.
|
||||
|
||||
Example:
|
||||
|
||||
```python
|
||||
>>> from transformers import Phi3Model, Phi3Config
|
||||
|
||||
>>> # Initializing a Phi-3 style configuration
|
||||
>>> configuration = Phi3Config.from_pretrained("microsoft/Phi-3-mini-4k-instruct")
|
||||
|
||||
>>> # Initializing a model from the configuration
|
||||
>>> model = Phi3Model(configuration)
|
||||
|
||||
>>> # Accessing the model configuration
|
||||
>>> configuration = model.config
|
||||
```"""
|
||||
|
||||
model_type = "phi3"
|
||||
keys_to_ignore_at_inference = ["past_key_values"]
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
vocab_size=32064,
|
||||
hidden_size=3072,
|
||||
intermediate_size=8192,
|
||||
num_hidden_layers=32,
|
||||
num_attention_heads=32,
|
||||
num_key_value_heads=None,
|
||||
resid_pdrop=0.0,
|
||||
embd_pdrop=0.0,
|
||||
attention_dropout=0.0,
|
||||
hidden_act="silu",
|
||||
max_position_embeddings=4096,
|
||||
original_max_position_embeddings=4096,
|
||||
initializer_range=0.02,
|
||||
rms_norm_eps=1e-5,
|
||||
use_cache=True,
|
||||
tie_word_embeddings=False,
|
||||
rope_theta=10000.0,
|
||||
rope_scaling=None,
|
||||
bos_token_id=1,
|
||||
eos_token_id=32000,
|
||||
pad_token_id=32000,
|
||||
sliding_window=None,
|
||||
**kwargs,
|
||||
):
|
||||
self.vocab_size = vocab_size
|
||||
self.hidden_size = hidden_size
|
||||
self.intermediate_size = intermediate_size
|
||||
self.num_hidden_layers = num_hidden_layers
|
||||
self.num_attention_heads = num_attention_heads
|
||||
|
||||
if num_key_value_heads is None:
|
||||
num_key_value_heads = num_attention_heads
|
||||
|
||||
self.num_key_value_heads = num_key_value_heads
|
||||
self.resid_pdrop = resid_pdrop
|
||||
self.embd_pdrop = embd_pdrop
|
||||
self.attention_dropout = attention_dropout
|
||||
self.hidden_act = hidden_act
|
||||
self.max_position_embeddings = max_position_embeddings
|
||||
self.original_max_position_embeddings = original_max_position_embeddings
|
||||
self.initializer_range = initializer_range
|
||||
self.rms_norm_eps = rms_norm_eps
|
||||
self.use_cache = use_cache
|
||||
self.rope_theta = rope_theta
|
||||
self.rope_scaling = rope_scaling
|
||||
self._rope_scaling_adjustment()
|
||||
self._rope_scaling_validation()
|
||||
self.sliding_window = sliding_window
|
||||
|
||||
super().__init__(
|
||||
bos_token_id=bos_token_id,
|
||||
eos_token_id=eos_token_id,
|
||||
pad_token_id=pad_token_id,
|
||||
tie_word_embeddings=tie_word_embeddings,
|
||||
**kwargs,
|
||||
)
|
||||
|
||||
def _rope_scaling_adjustment(self):
|
||||
"""
|
||||
Adjust the `type` of the `rope_scaling` configuration for backward compatibility.
|
||||
"""
|
||||
if self.rope_scaling is None:
|
||||
return
|
||||
|
||||
rope_scaling_type = self.rope_scaling.get("type", None)
|
||||
|
||||
# For backward compatibility if previous version used "su" or "yarn"
|
||||
if rope_scaling_type is not None and rope_scaling_type in ["su", "yarn"]:
|
||||
self.rope_scaling["type"] = "longrope"
|
||||
|
||||
def _rope_scaling_validation(self):
|
||||
"""
|
||||
Validate the `rope_scaling` configuration.
|
||||
"""
|
||||
if self.rope_scaling is None:
|
||||
return
|
||||
|
||||
if not isinstance(self.rope_scaling, dict) or len(self.rope_scaling) != 3:
|
||||
raise ValueError(
|
||||
"`rope_scaling` must be a dictionary with three fields, `type`, `short_factor` and `long_factor`, "
|
||||
f"got {self.rope_scaling}"
|
||||
)
|
||||
rope_scaling_type = self.rope_scaling.get("type", None)
|
||||
rope_scaling_short_factor = self.rope_scaling.get("short_factor", None)
|
||||
rope_scaling_long_factor = self.rope_scaling.get("long_factor", None)
|
||||
if rope_scaling_type is None or rope_scaling_type not in ["longrope"]:
|
||||
raise ValueError(f"`rope_scaling`'s type field must be one of ['longrope'], got {rope_scaling_type}")
|
||||
if not (
|
||||
isinstance(rope_scaling_short_factor, list)
|
||||
and all(isinstance(x, (int, float)) for x in rope_scaling_short_factor)
|
||||
):
|
||||
raise ValueError(
|
||||
f"`rope_scaling`'s short_factor field must be a list of numbers, got {rope_scaling_short_factor}"
|
||||
)
|
||||
if not len(rope_scaling_short_factor) == self.hidden_size // self.num_attention_heads // 2:
|
||||
raise ValueError(
|
||||
f"`rope_scaling`'s short_factor field must have length {self.hidden_size // self.num_attention_heads // 2}, got {len(rope_scaling_short_factor)}"
|
||||
)
|
||||
if not (
|
||||
isinstance(rope_scaling_long_factor, list)
|
||||
and all(isinstance(x, (int, float)) for x in rope_scaling_long_factor)
|
||||
):
|
||||
raise ValueError(
|
||||
f"`rope_scaling`'s long_factor field must be a list of numbers, got {rope_scaling_long_factor}"
|
||||
)
|
||||
if not len(rope_scaling_long_factor) == self.hidden_size // self.num_attention_heads // 2:
|
||||
raise ValueError(
|
||||
f"`rope_scaling`'s long_factor field must have length {self.hidden_size // self.num_attention_heads // 2}, got {len(rope_scaling_long_factor)}"
|
||||
)
|
||||
11
generation_config.json
Normal file
11
generation_config.json
Normal file
@@ -0,0 +1,11 @@
|
||||
{
|
||||
"_from_model_config": true,
|
||||
"bos_token_id": 1,
|
||||
"eos_token_id": [
|
||||
32007,
|
||||
32001,
|
||||
32000
|
||||
],
|
||||
"pad_token_id": 32000,
|
||||
"transformers_version": "5.2.0"
|
||||
}
|
||||
3
model-00001-of-00002.safetensors
Normal file
3
model-00001-of-00002.safetensors
Normal file
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:de637e864f1edb1a5fcf14fc63a3563f30595fb2568ef58804f8966fc23095af
|
||||
size 3821087672
|
||||
3
model-00002-of-00002.safetensors
Normal file
3
model-00002-of-00002.safetensors
Normal file
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:5d2b7788e70e7aa86ae67ec4f21298cf5a478b24d9bc56036f37c55a6b22e1b2
|
||||
size 3821093952
|
||||
1
model.safetensors.index.json
Normal file
1
model.safetensors.index.json
Normal file
File diff suppressed because one or more lines are too long
1570
modeling_phi3.py
Normal file
1570
modeling_phi3.py
Normal file
File diff suppressed because it is too large
Load Diff
3
pytorch_model.bin
Normal file
3
pytorch_model.bin
Normal file
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:21ae1819a4783e828fd9d098edc8d2e51679c031b5e364a908dac692ed8e061d
|
||||
size 7642246591
|
||||
214
sample_finetune.py
Normal file
214
sample_finetune.py
Normal file
@@ -0,0 +1,214 @@
|
||||
import sys
|
||||
import logging
|
||||
|
||||
import datasets
|
||||
from datasets import load_dataset
|
||||
from peft import LoraConfig
|
||||
import torch
|
||||
import transformers
|
||||
from trl import SFTTrainer
|
||||
from transformers import AutoModelForCausalLM, AutoTokenizer, TrainingArguments, BitsAndBytesConfig
|
||||
|
||||
"""
|
||||
A simple example on using SFTTrainer and Accelerate to finetune Phi-3 models. For
|
||||
a more advanced example, please follow HF alignment-handbook/scripts/run_sft.py.
|
||||
This example has utilized DeepSpeed ZeRO3 offload to reduce the memory usage. The
|
||||
script can be run on V100 or later generation GPUs. Here are some suggestions on
|
||||
futher reducing memory consumption:
|
||||
- reduce batch size
|
||||
- decrease lora dimension
|
||||
- restrict lora target modules
|
||||
Please follow these steps to run the script:
|
||||
1. Install dependencies:
|
||||
conda install -c conda-forge accelerate
|
||||
pip3 install -i https://pypi.org/simple/ bitsandbytes
|
||||
pip3 install peft transformers trl datasets
|
||||
pip3 install deepspeed
|
||||
2. Setup accelerate and deepspeed config based on the machine used:
|
||||
accelerate config
|
||||
Here is a sample config for deepspeed zero3:
|
||||
compute_environment: LOCAL_MACHINE
|
||||
debug: false
|
||||
deepspeed_config:
|
||||
gradient_accumulation_steps: 1
|
||||
offload_optimizer_device: none
|
||||
offload_param_device: none
|
||||
zero3_init_flag: true
|
||||
zero3_save_16bit_model: true
|
||||
zero_stage: 3
|
||||
distributed_type: DEEPSPEED
|
||||
downcast_bf16: 'no'
|
||||
enable_cpu_affinity: false
|
||||
machine_rank: 0
|
||||
main_training_function: main
|
||||
mixed_precision: bf16
|
||||
num_machines: 1
|
||||
num_processes: 4
|
||||
rdzv_backend: static
|
||||
same_network: true
|
||||
tpu_env: []
|
||||
tpu_use_cluster: false
|
||||
tpu_use_sudo: false
|
||||
use_cpu: false
|
||||
3. check accelerate config:
|
||||
accelerate env
|
||||
4. Run the code:
|
||||
accelerate launch sample_finetune.py
|
||||
"""
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
###################
|
||||
# Hyper-parameters
|
||||
###################
|
||||
training_config = {
|
||||
"bf16": True,
|
||||
"do_eval": False,
|
||||
"learning_rate": 5.0e-06,
|
||||
"log_level": "info",
|
||||
"logging_steps": 20,
|
||||
"logging_strategy": "steps",
|
||||
"lr_scheduler_type": "cosine",
|
||||
"num_train_epochs": 1,
|
||||
"max_steps": -1,
|
||||
"output_dir": "./checkpoint_dir",
|
||||
"overwrite_output_dir": True,
|
||||
"per_device_eval_batch_size": 4,
|
||||
"per_device_train_batch_size": 4,
|
||||
"remove_unused_columns": True,
|
||||
"save_steps": 100,
|
||||
"save_total_limit": 1,
|
||||
"seed": 0,
|
||||
"gradient_checkpointing": True,
|
||||
"gradient_checkpointing_kwargs":{"use_reentrant": False},
|
||||
"gradient_accumulation_steps": 1,
|
||||
"warmup_ratio": 0.2,
|
||||
}
|
||||
|
||||
peft_config = {
|
||||
"r": 16,
|
||||
"lora_alpha": 32,
|
||||
"lora_dropout": 0.05,
|
||||
"bias": "none",
|
||||
"task_type": "CAUSAL_LM",
|
||||
"target_modules": "all-linear",
|
||||
"modules_to_save": None,
|
||||
}
|
||||
train_conf = TrainingArguments(**training_config)
|
||||
peft_conf = LoraConfig(**peft_config)
|
||||
|
||||
|
||||
###############
|
||||
# Setup logging
|
||||
###############
|
||||
logging.basicConfig(
|
||||
format="%(asctime)s - %(levelname)s - %(name)s - %(message)s",
|
||||
datefmt="%Y-%m-%d %H:%M:%S",
|
||||
handlers=[logging.StreamHandler(sys.stdout)],
|
||||
)
|
||||
log_level = train_conf.get_process_log_level()
|
||||
logger.setLevel(log_level)
|
||||
datasets.utils.logging.set_verbosity(log_level)
|
||||
transformers.utils.logging.set_verbosity(log_level)
|
||||
transformers.utils.logging.enable_default_handler()
|
||||
transformers.utils.logging.enable_explicit_format()
|
||||
|
||||
# Log on each process a small summary
|
||||
logger.warning(
|
||||
f"Process rank: {train_conf.local_rank}, device: {train_conf.device}, n_gpu: {train_conf.n_gpu}"
|
||||
+ f" distributed training: {bool(train_conf.local_rank != -1)}, 16-bits training: {train_conf.fp16}"
|
||||
)
|
||||
logger.info(f"Training/evaluation parameters {train_conf}")
|
||||
logger.info(f"PEFT parameters {peft_conf}")
|
||||
|
||||
|
||||
################
|
||||
# Model Loading
|
||||
################
|
||||
|
||||
checkpoint_path = "microsoft/Phi-3.5-mini-instruct"
|
||||
model_kwargs = dict(
|
||||
use_cache=False,
|
||||
trust_remote_code=True,
|
||||
attn_implementation="flash_attention_2", # loading the model with flash-attenstion support
|
||||
torch_dtype=torch.bfloat16,
|
||||
device_map=None
|
||||
)
|
||||
model = AutoModelForCausalLM.from_pretrained(checkpoint_path, **model_kwargs)
|
||||
tokenizer = AutoTokenizer.from_pretrained(checkpoint_path)
|
||||
tokenizer.model_max_length = 2048
|
||||
tokenizer.pad_token = tokenizer.unk_token # use unk rather than eos token to prevent endless generation
|
||||
tokenizer.pad_token_id = tokenizer.convert_tokens_to_ids(tokenizer.pad_token)
|
||||
tokenizer.padding_side = 'right'
|
||||
|
||||
|
||||
##################
|
||||
# Data Processing
|
||||
##################
|
||||
def apply_chat_template(
|
||||
example,
|
||||
tokenizer,
|
||||
):
|
||||
messages = example["messages"]
|
||||
example["text"] = tokenizer.apply_chat_template(
|
||||
messages, tokenize=False, add_generation_prompt=False)
|
||||
return example
|
||||
|
||||
raw_dataset = load_dataset("HuggingFaceH4/ultrachat_200k")
|
||||
train_dataset = raw_dataset["train_sft"]
|
||||
test_dataset = raw_dataset["test_sft"]
|
||||
column_names = list(train_dataset.features)
|
||||
|
||||
processed_train_dataset = train_dataset.map(
|
||||
apply_chat_template,
|
||||
fn_kwargs={"tokenizer": tokenizer},
|
||||
num_proc=10,
|
||||
remove_columns=column_names,
|
||||
desc="Applying chat template to train_sft",
|
||||
)
|
||||
|
||||
processed_test_dataset = test_dataset.map(
|
||||
apply_chat_template,
|
||||
fn_kwargs={"tokenizer": tokenizer},
|
||||
num_proc=10,
|
||||
remove_columns=column_names,
|
||||
desc="Applying chat template to test_sft",
|
||||
)
|
||||
|
||||
|
||||
###########
|
||||
# Training
|
||||
###########
|
||||
trainer = SFTTrainer(
|
||||
model=model,
|
||||
args=train_conf,
|
||||
peft_config=peft_conf,
|
||||
train_dataset=processed_train_dataset,
|
||||
eval_dataset=processed_test_dataset,
|
||||
max_seq_length=2048,
|
||||
dataset_text_field="text",
|
||||
tokenizer=tokenizer,
|
||||
packing=True
|
||||
)
|
||||
train_result = trainer.train()
|
||||
metrics = train_result.metrics
|
||||
trainer.log_metrics("train", metrics)
|
||||
trainer.save_metrics("train", metrics)
|
||||
trainer.save_state()
|
||||
|
||||
|
||||
#############
|
||||
# Evaluation
|
||||
#############
|
||||
tokenizer.padding_side = 'left'
|
||||
metrics = trainer.evaluate()
|
||||
metrics["eval_samples"] = len(processed_test_dataset)
|
||||
trainer.log_metrics("eval", metrics)
|
||||
trainer.save_metrics("eval", metrics)
|
||||
|
||||
|
||||
# ############
|
||||
# # Save model
|
||||
# ############
|
||||
trainer.save_model(train_conf.output_dir)
|
||||
30
special_tokens_map.json
Normal file
30
special_tokens_map.json
Normal file
@@ -0,0 +1,30 @@
|
||||
{
|
||||
"bos_token": {
|
||||
"content": "<s>",
|
||||
"lstrip": false,
|
||||
"normalized": false,
|
||||
"rstrip": false,
|
||||
"single_word": false
|
||||
},
|
||||
"eos_token": {
|
||||
"content": "<|endoftext|>",
|
||||
"lstrip": false,
|
||||
"normalized": false,
|
||||
"rstrip": false,
|
||||
"single_word": false
|
||||
},
|
||||
"pad_token": {
|
||||
"content": "<|endoftext|>",
|
||||
"lstrip": false,
|
||||
"normalized": false,
|
||||
"rstrip": false,
|
||||
"single_word": false
|
||||
},
|
||||
"unk_token": {
|
||||
"content": "<unk>",
|
||||
"lstrip": false,
|
||||
"normalized": false,
|
||||
"rstrip": false,
|
||||
"single_word": false
|
||||
}
|
||||
}
|
||||
277210
tokenizer.json
Normal file
277210
tokenizer.json
Normal file
File diff suppressed because it is too large
Load Diff
15
tokenizer_config.json
Normal file
15
tokenizer_config.json
Normal file
@@ -0,0 +1,15 @@
|
||||
{
|
||||
"backend": "tokenizers",
|
||||
"bos_token": "<s>",
|
||||
"clean_up_tokenization_spaces": false,
|
||||
"eos_token": "<|endoftext|>",
|
||||
"is_local": false,
|
||||
"legacy": false,
|
||||
"model_max_length": 131072,
|
||||
"pad_token": "<|endoftext|>",
|
||||
"padding_side": "left",
|
||||
"sp_model_kwargs": {},
|
||||
"tokenizer_class": "TokenizersBackend",
|
||||
"unk_token": "<unk>",
|
||||
"use_default_system_prompt": false
|
||||
}
|
||||
Reference in New Issue
Block a user