Update README.md
#1
by
shakebenn
- opened
README.md
CHANGED
@@ -2,199 +2,109 @@
|
|
2 |
library_name: transformers
|
3 |
tags:
|
4 |
- unsloth
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
5 |
---
|
6 |
|
7 |
-
#
|
8 |
|
9 |
-
|
10 |
|
|
|
11 |
|
|
|
12 |
|
13 |
-
|
|
|
|
|
|
|
|
|
|
|
14 |
|
15 |
-
###
|
16 |
|
17 |
-
|
18 |
|
19 |
-
|
20 |
|
21 |
-
|
22 |
-
- **Funded by [optional]:** [More Information Needed]
|
23 |
-
- **Shared by [optional]:** [More Information Needed]
|
24 |
-
- **Model type:** [More Information Needed]
|
25 |
-
- **Language(s) (NLP):** [More Information Needed]
|
26 |
-
- **License:** [More Information Needed]
|
27 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
28 |
|
29 |
-
|
|
|
|
|
|
|
|
|
30 |
|
31 |
-
|
32 |
|
33 |
-
|
34 |
-
-
|
35 |
-
-
|
|
|
|
|
36 |
|
37 |
-
##
|
38 |
|
39 |
-
|
|
|
|
|
40 |
|
41 |
-
###
|
42 |
|
43 |
-
|
|
|
|
|
44 |
|
45 |
-
|
46 |
|
47 |
-
|
48 |
|
49 |
-
|
50 |
|
51 |
-
|
|
|
|
|
52 |
|
53 |
-
###
|
54 |
|
55 |
-
|
|
|
|
|
56 |
|
57 |
-
|
58 |
|
59 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
60 |
|
61 |
-
|
62 |
|
63 |
-
|
64 |
|
65 |
-
|
|
|
|
|
66 |
|
67 |
-
|
68 |
-
|
69 |
-
|
70 |
-
|
71 |
-
|
72 |
-
|
73 |
-
Use the code below to get started with the model.
|
74 |
-
|
75 |
-
[More Information Needed]
|
76 |
-
|
77 |
-
## Training Details
|
78 |
-
|
79 |
-
### Training Data
|
80 |
-
|
81 |
-
<!-- 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. -->
|
82 |
-
|
83 |
-
[More Information Needed]
|
84 |
-
|
85 |
-
### Training Procedure
|
86 |
-
|
87 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
88 |
-
|
89 |
-
#### Preprocessing [optional]
|
90 |
-
|
91 |
-
[More Information Needed]
|
92 |
-
|
93 |
-
|
94 |
-
#### Training Hyperparameters
|
95 |
-
|
96 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
97 |
-
|
98 |
-
#### Speeds, Sizes, Times [optional]
|
99 |
-
|
100 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
101 |
-
|
102 |
-
[More Information Needed]
|
103 |
-
|
104 |
-
## Evaluation
|
105 |
-
|
106 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
107 |
-
|
108 |
-
### Testing Data, Factors & Metrics
|
109 |
-
|
110 |
-
#### Testing Data
|
111 |
-
|
112 |
-
<!-- This should link to a Dataset Card if possible. -->
|
113 |
-
|
114 |
-
[More Information Needed]
|
115 |
-
|
116 |
-
#### Factors
|
117 |
-
|
118 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
119 |
-
|
120 |
-
[More Information Needed]
|
121 |
-
|
122 |
-
#### Metrics
|
123 |
-
|
124 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
125 |
-
|
126 |
-
[More Information Needed]
|
127 |
-
|
128 |
-
### Results
|
129 |
-
|
130 |
-
[More Information Needed]
|
131 |
-
|
132 |
-
#### Summary
|
133 |
-
|
134 |
-
|
135 |
-
|
136 |
-
## Model Examination [optional]
|
137 |
-
|
138 |
-
<!-- Relevant interpretability work for the model goes here -->
|
139 |
-
|
140 |
-
[More Information Needed]
|
141 |
-
|
142 |
-
## Environmental Impact
|
143 |
-
|
144 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
145 |
-
|
146 |
-
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).
|
147 |
-
|
148 |
-
- **Hardware Type:** [More Information Needed]
|
149 |
-
- **Hours used:** [More Information Needed]
|
150 |
-
- **Cloud Provider:** [More Information Needed]
|
151 |
-
- **Compute Region:** [More Information Needed]
|
152 |
-
- **Carbon Emitted:** [More Information Needed]
|
153 |
-
|
154 |
-
## Technical Specifications [optional]
|
155 |
-
|
156 |
-
### Model Architecture and Objective
|
157 |
-
|
158 |
-
[More Information Needed]
|
159 |
-
|
160 |
-
### Compute Infrastructure
|
161 |
-
|
162 |
-
[More Information Needed]
|
163 |
-
|
164 |
-
#### Hardware
|
165 |
-
|
166 |
-
[More Information Needed]
|
167 |
-
|
168 |
-
#### Software
|
169 |
-
|
170 |
-
[More Information Needed]
|
171 |
-
|
172 |
-
## Citation [optional]
|
173 |
-
|
174 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
175 |
-
|
176 |
-
**BibTeX:**
|
177 |
-
|
178 |
-
[More Information Needed]
|
179 |
-
|
180 |
-
**APA:**
|
181 |
-
|
182 |
-
[More Information Needed]
|
183 |
-
|
184 |
-
## Glossary [optional]
|
185 |
-
|
186 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
187 |
-
|
188 |
-
[More Information Needed]
|
189 |
-
|
190 |
-
## More Information [optional]
|
191 |
-
|
192 |
-
[More Information Needed]
|
193 |
-
|
194 |
-
## Model Card Authors [optional]
|
195 |
-
|
196 |
-
[More Information Needed]
|
197 |
-
|
198 |
-
## Model Card Contact
|
199 |
-
|
200 |
-
[More Information Needed]
|
|
|
2 |
library_name: transformers
|
3 |
tags:
|
4 |
- unsloth
|
5 |
+
- japanese
|
6 |
+
- llm-jp
|
7 |
+
- lora
|
8 |
+
datasets:
|
9 |
+
- GENIAC-Team-Ozaki/Hachi-Alpaca_newans
|
10 |
+
- llm-jp/magpie-sft-v1.0
|
11 |
+
language:
|
12 |
+
- ja
|
13 |
+
base_model:
|
14 |
+
- llm-jp/llm-jp-3-13b
|
15 |
---
|
16 |
|
17 |
+
# llm-jp-3-13b-SFT-LoRA モデルカード
|
18 |
|
19 |
+
llm-jp-3-13bをベースに、QLoRAとUnslothを用いて効率的なファインチューニングを行った日本語言語モデルです。
|
20 |
|
21 |
+
## モデルの詳細
|
22 |
|
23 |
+
### モデルの説明
|
24 |
|
25 |
+
- **開発者:** GENIAC Team
|
26 |
+
- **共有者:** GENIAC Team
|
27 |
+
- **モデルタイプ:** 言語モデル(デコーダーのみ)
|
28 |
+
- **言語:** 日本語
|
29 |
+
- **ライセンス:** ベースモデルに準拠
|
30 |
+
- **ベースモデル:** llm-jp/llm-jp-3-13b
|
31 |
|
32 |
+
### モデルソース
|
33 |
|
34 |
+
- **リポジトリ:** https://huggingface.co/llm-jp/llm-jp-3-13b
|
35 |
|
36 |
+
## 使用方法
|
37 |
|
38 |
+
### 直接利用
|
|
|
|
|
|
|
|
|
|
|
|
|
39 |
|
40 |
+
このモデルは以下のような用途に適しています:
|
41 |
+
- 質問応答
|
42 |
+
- テキスト生成
|
43 |
+
- 文章要約
|
44 |
+
- その他の自然言語処理タスク
|
45 |
|
46 |
+
### 対象外の使用
|
47 |
|
48 |
+
以下の用途での使用は推奨されません:
|
49 |
+
- 商用利用
|
50 |
+
- 重要な意思決定
|
51 |
+
- 医療・法律アドバイス
|
52 |
+
- 有害なコンテンツの生成
|
53 |
|
54 |
+
## バイアス、リスク、制限事項
|
55 |
|
56 |
+
- 学習データに起因するバイアスが存在する可能性があります
|
57 |
+
- 事実と異なる情報を生成する可能性があります
|
58 |
+
- 有害なコンテンツを生成する可能性があります
|
59 |
|
60 |
+
### 推奨事項
|
61 |
|
62 |
+
- 出力内容の検証を必ず行ってください
|
63 |
+
- センシティブな用途での使用は避けてください
|
64 |
+
- 生成された内容の責任は使用者が負うものとします
|
65 |
|
66 |
+
## モデルの使用開始方法
|
67 |
|
68 |
+
## 学習の詳細
|
69 |
|
70 |
+
### 学習データ
|
71 |
|
72 |
+
以下のデータセットを使用:
|
73 |
+
- GENIAC-Team-Ozaki/Hachi-Alpaca_newans
|
74 |
+
- llm-jp/magpie-sft-v1.0
|
75 |
|
76 |
+
### 学習手順
|
77 |
|
78 |
+
#### 前処理
|
79 |
+
- 指示文と回答のペアにフォーマット
|
80 |
+
- コンテキスト長を512トークンに制限
|
81 |
|
82 |
+
#### 学習ハイパーパラメータ
|
83 |
|
84 |
+
- **学習手法:** QLoRA with Unsloth
|
85 |
+
- **量子化:** 4-bit
|
86 |
+
- **LoRA設定:**
|
87 |
+
- rank (r): 32
|
88 |
+
- alpha: 32
|
89 |
+
- dropout: 0.05
|
90 |
+
- target_modules: ["q_proj", "k_proj", "v_proj", "o_proj", "gate_proj", "up_proj", "down_proj"]
|
91 |
+
- **トレーニング設定:**
|
92 |
+
- バッチサイズ: 2
|
93 |
+
- 勾配累積: 4
|
94 |
+
- エポック数: 1
|
95 |
+
- 学習率: 2e-4
|
96 |
+
- シーケンス長: 512
|
97 |
|
98 |
+
## 技術仕様
|
99 |
|
100 |
+
### 計算インフラ
|
101 |
|
102 |
+
#### ハードウェア要件
|
103 |
+
- CUDA対応GPU
|
104 |
+
- 最小8GB VRAM推奨
|
105 |
|
106 |
+
#### ソフトウェア要件
|
107 |
+
- Python 3.10以上
|
108 |
+
- PyTorch 2.0以上
|
109 |
+
- Transformers最新版
|
110 |
+
- Unsloth(推奨)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|