Update README.md
Browse files
README.md
CHANGED
@@ -1,3 +1,177 @@
|
|
1 |
-
---
|
2 |
-
license: apache-2.0
|
3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
---
|
2 |
+
license: apache-2.0
|
3 |
+
language:
|
4 |
+
- en
|
5 |
+
- ja
|
6 |
+
programming_language:
|
7 |
+
- C
|
8 |
+
- C++
|
9 |
+
- C#
|
10 |
+
- Go
|
11 |
+
- Java
|
12 |
+
- JavaScript
|
13 |
+
- Lua
|
14 |
+
- PHP
|
15 |
+
- Python
|
16 |
+
- Ruby
|
17 |
+
- Rust
|
18 |
+
- Scala
|
19 |
+
- TypeScript
|
20 |
+
pipeline_tag: text-generation
|
21 |
+
library_name: transformers
|
22 |
+
inference: false
|
23 |
+
---
|
24 |
+
|
25 |
+
# llm-jp-3-13b-instruct
|
26 |
+
|
27 |
+
This repository provides large language models developed by the [Research and Development Center for Large Language Models](https://llmc.nii.ac.jp/) at the [National Institute of Informatics](https://www.nii.ac.jp/en/).
|
28 |
+
|
29 |
+
The development was partially supported by [GENIAC](https://www.meti.go.jp/policy/mono_info_service/geniac/index.html).
|
30 |
+
|
31 |
+
| Model Variants |
|
32 |
+
| :--- |
|
33 |
+
| [llm-jp-3-1.8b](https://huggingface.co/llm-jp/llm-jp-3-1.8b) |
|
34 |
+
| [llm-jp-3-1.8b-instruct](https://huggingface.co/llm-jp/llm-jp-3-1.8b-instruct) |
|
35 |
+
| [llm-jp-3-3.7b](https://huggingface.co/llm-jp/llm-jp-3-3.7b) |
|
36 |
+
| [llm-jp-3-3.7b-instruct](https://huggingface.co/llm-jp/llm-jp-3-3.7b-instruct) |
|
37 |
+
| [llm-jp-3-13b](https://huggingface.co/llm-jp/llm-jp-3-13b) |
|
38 |
+
| [llm-jp-3-13b-instruct](https://huggingface.co/llm-jp/llm-jp-3-13b-instruct) |
|
39 |
+
| [llm-jp-3-172b-beta1](https://huggingface.co/llm-jp/llm-jp-3-172b-beta1) |
|
40 |
+
| [llm-jp-3-172b-beta1-instruct](https://huggingface.co/llm-jp/llm-jp-3-172b-beta1-instruct) |
|
41 |
+
|
42 |
+
|
43 |
+
Checkpoints format: Hugging Face Transformers
|
44 |
+
|
45 |
+
## Required Libraries and Their Versions
|
46 |
+
|
47 |
+
- torch>=2.3.0
|
48 |
+
- transformers>=4.40.1
|
49 |
+
- tokenizers>=0.19.1
|
50 |
+
- accelerate>=0.29.3
|
51 |
+
- flash-attn>=2.5.8
|
52 |
+
|
53 |
+
## Usage
|
54 |
+
|
55 |
+
```python
|
56 |
+
import torch
|
57 |
+
from transformers import AutoTokenizer, AutoModelForCausalLM
|
58 |
+
tokenizer = AutoTokenizer.from_pretrained("llm-jp/llm-jp-3-13b-instruct")
|
59 |
+
model = AutoModelForCausalLM.from_pretrained("llm-jp/llm-jp-3-13b-instruct", device_map="auto", torch_dtype=torch.bfloat16)
|
60 |
+
chat = [
|
61 |
+
{"role": "system", "content": "以下は、タスクを説明する指示です。要求を適切に満たす応答を書きなさい。"},
|
62 |
+
{"role": "user", "content": "自然言語処理とは何か"},
|
63 |
+
]
|
64 |
+
tokenized_input = tokenizer.apply_chat_template(chat, add_generation_prompt=True, tokenize=True, return_tensors="pt").to(model.device)
|
65 |
+
with torch.no_grad():
|
66 |
+
output = model.generate(
|
67 |
+
tokenized_input,
|
68 |
+
max_new_tokens=100,
|
69 |
+
do_sample=True,
|
70 |
+
top_p=0.95,
|
71 |
+
temperature=0.7,
|
72 |
+
repetition_penalty=1.05,
|
73 |
+
)[0]
|
74 |
+
print(tokenizer.decode(output))
|
75 |
+
```
|
76 |
+
|
77 |
+
## Model Details
|
78 |
+
|
79 |
+
- **Model type:** Transformer-based Language Model
|
80 |
+
- **Total seen tokens:** 2.1T
|
81 |
+
|
82 |
+
|Params|Layers|Hidden size|Heads|Context length|Embedding parameters|Non-embedding parameters|
|
83 |
+
|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
|
84 |
+
|1.8b|24|2048|16|4096|407,896,064|1,459,718,144|
|
85 |
+
|3.7b|28|3072|24|4096|611,844,096|3,171,068,928|
|
86 |
+
|13b|40|5120|40|4096|1,019,740,160|12,688,184,320|
|
87 |
+
|
88 |
+
## Tokenizer
|
89 |
+
|
90 |
+
The tokenizer of this model is based on [huggingface/tokenizers](https://github.com/huggingface/tokenizers) Unigram byte-fallback model.
|
91 |
+
The vocabulary entries were converted from [`llm-jp-tokenizer v3.0`](https://github.com/llm-jp/llm-jp-tokenizer/releases/tag/v3.0b2).
|
92 |
+
Please refer to [README.md](https://github.com/llm-jp/llm-jp-tokenizer) of `llm-jp-tokenizer` for details on the vocabulary construction procedure (the pure SentencePiece training does not reproduce our vocabulary).
|
93 |
+
|
94 |
+
## Datasets
|
95 |
+
|
96 |
+
### Pre-training
|
97 |
+
|
98 |
+
The models have been pre-trained using a blend of the following datasets.
|
99 |
+
|
100 |
+
| Language | Dataset | Tokens|
|
101 |
+
|:---|:---|---:|
|
102 |
+
|Japanese|[Wikipedia](https://gitlab.llm-jp.nii.ac.jp/datasets/llm-jp-corpus-v3)|2.6B
|
103 |
+
||[Common Crawl](https://gitlab.llm-jp.nii.ac.jp/datasets/llm-jp-corpus-v3)|762.8B
|
104 |
+
||[WARP/PDF](https://gitlab.llm-jp.nii.ac.jp/datasets/llm-jp-corpus-v3)|237.3B
|
105 |
+
||[WARP/HTML](https://gitlab.llm-jp.nii.ac.jp/datasets/llm-jp-corpus-v3)|2.7B
|
106 |
+
||[Kaken](https://gitlab.llm-jp.nii.ac.jp/datasets/llm-jp-corpus-v3)|1.8B
|
107 |
+
|English|[Wikipedia](https://gitlab.llm-jp.nii.ac.jp/datasets/llm-jp-corpus-v3)|4.7B
|
108 |
+
||[Dolma/CC-head](https://gitlab.llm-jp.nii.ac.jp/datasets/llm-jp-corpus-v3)|608.5B
|
109 |
+
||[Dolma/C4](https://gitlab.llm-jp.nii.ac.jp/datasets/llm-jp-corpus-v3)|181.6B
|
110 |
+
||[Dolma/Reddit](https://gitlab.llm-jp.nii.ac.jp/datasets/llm-jp-corpus-v3)|83.1B
|
111 |
+
||[Dolma/PeS2o](https://gitlab.llm-jp.nii.ac.jp/datasets/llm-jp-corpus-v3)|62.9B
|
112 |
+
||[Dolma/Gutenberg](https://gitlab.llm-jp.nii.ac.jp/datasets/llm-jp-corpus-v3)|5.5B
|
113 |
+
||[Dolma/Wiki](https://gitlab.llm-jp.nii.ac.jp/datasets/llm-jp-corpus-v3)|3.9B
|
114 |
+
|Code|[The Stack](https://huggingface.co/datasets/bigcode/the-stack)|114.1B
|
115 |
+
|Chinese|[Wikipedia](https://huggingface.co/datasets/bigcode/the-stack)|0.8B
|
116 |
+
|Korean|[Wikipedia](https://huggingface.co/datasets/bigcode/the-stack)|0.3B
|
117 |
+
|
118 |
+
### Instruction tuning
|
119 |
+
|
120 |
+
The models have been fine-tuned on the following datasets.
|
121 |
+
|
122 |
+
| Language | Dataset | description |
|
123 |
+
|:---|:---|:---|
|
124 |
+
|Japanese|[ichikara-instruction-004-002](https://liat-aip.sakura.ne.jp/wp/llm%e3%81%ae%e3%81%9f%e3%82%81%e3%81%ae%e6%97%a5%e6%9c%ac%e8%aa%9e%e3%82%a4%e3%83%b3%e3%82%b9%e3%83%88%e3%83%a9%e3%82%af%e3%82%b7%e3%83%a7%e3%83%b3%e3%83%87%e3%83%bc%e3%82%bf%e4%bd%9c%e6%88%90/llm%e3%81%ae%e3%81%9f%e3%82%81%e3%81%ae%e6%97%a5%e6%9c%ac%e8%aa%9e%e3%82%a4%e3%83%b3%e3%82%b9%e3%83%88%e3%83%a9%e3%82%af%e3%82%b7%e3%83%a7%e3%83%b3%e3%83%87%e3%83%bc%e3%82%bf-%e5%85%ac%e9%96%8b/)| A manually constructed instruction dataset |
|
125 |
+
| |[answer-carefully-002](https://liat-aip.sakura.ne.jp/wp/answercarefully-dataset/)| A manually constructed instruction dataset focusing on LLMs' safety |
|
126 |
+
| |ichikara-instruction-format| A small amount of instruction dataset edited from ichikara-instruction, with some constraints on the output format. |
|
127 |
+
| |[AutoMultiTurnByCalm3-22B](https://huggingface.co/datasets/kanhatakeyama/AutoMultiTurnByCalm3-22B)| A synthetic instruction dataset. |
|
128 |
+
| |[ramdom-to-fixed-multiturn-Calm3](https://huggingface.co/datasets/kanhatakeyama/ramdom-to-fixed-multiturn-Calm3)| A synthetic instruction dataset. |
|
129 |
+
| |[wizardlm8x22b-logical-math-coding-sft_additional-ja](https://huggingface.co/datasets/kanhatakeyama/wizardlm8x22b-logical-math-coding-sft_additional-ja)| A synthetic instruction dataset. |
|
130 |
+
| |[Synthetic-JP-EN-Coding-Dataset-567k](https://huggingface.co/datasets/Aratako/Synthetic-JP-EN-Coding-Dataset-567k)| A synthetic instruction dataset. We used sampled one.|
|
131 |
+
|English |[FLAN](https://huggingface.co/datasets/Open-Orca/FLAN) | We used sampled one. |
|
132 |
+
|
133 |
+
|
134 |
+
## Evaluation
|
135 |
+
|
136 |
+
### llm-jp-eval (v1.3.1)
|
137 |
+
|
138 |
+
We evaluated the models using 100 examples from the dev split.
|
139 |
+
|
140 |
+
| Model name | average | EL | FA | HE | MC | MR | MT | NLI | QA | RC |
|
141 |
+
| :--- | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ---: |
|
142 |
+
| [llm-jp-3-1.8b](https://huggingface.co/llm-jp/llm-jp-3-1.8b) | 0.3767 | 0.3725 | 0.1948 | 0.2350 | 0.2500 | 0.0900 | 0.7730 | 0.3080 | 0.4629 | 0.7040 |
|
143 |
+
| [llm-jp-3-1.8b-instruct](https://huggingface.co/llm-jp/llm-jp-3-1.8b-instruct) | 0.4596 | 0.4280 | 0.1987 | 0.3250 | 0.3300 | 0.4200 | 0.7900 | 0.3520 | 0.4698 | 0.8224 |
|
144 |
+
| [llm-jp-3-3.7b](https://huggingface.co/llm-jp/llm-jp-3-3.7b) | 0.4231 | 0.3812 | 0.2440 | 0.2200 | 0.1900 | 0.3600 | 0.7947 | 0.3800 | 0.4688 | 0.7694 |
|
145 |
+
| [llm-jp-3-3.7b-instruct](https://huggingface.co/llm-jp/llm-jp-3-3.7b-instruct) | 0.5188 | 0.4191 | 0.2504 | 0.3400 | 0.5000 | 0.5800 | 0.8166 | 0.4500 | 0.4881 | 0.8247 |
|
146 |
+
| [llm-jp-3-13b](https://huggingface.co/llm-jp/llm-jp-3-13b) | 0.5802 | 0.5570 | 0.2593 | 0.4600 | 0.7000 | 0.6300 | 0.8292 | 0.3460 | 0.5937 | 0.8469 |
|
147 |
+
| [llm-jp-3-13b-instruct](https://huggingface.co/llm-jp/llm-jp-3-13b-instruct) | 0.6168 | 0.5408 | 0.2757 | 0.4950 | 0.9200 | 0.7100 | 0.8317 | 0.4640 | 0.4642 | 0.8500 |
|
148 |
+
|
149 |
+
|
150 |
+
### Japanese MT Bench
|
151 |
+
|
152 |
+
| Model name | average | coding | extraction | humanities | math | reasoning | roleplay | stem | writing |
|
153 |
+
| :--- | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ---: |
|
154 |
+
| [llm-jp-3-1.8b-instruct](https://huggingface.co/llm-jp/llm-jp-3-1.8b-instruct) | 4.93 | 1.50 | 4.70 | 7.80 | 1.55 | 2.60 | 7.80 | 6.10 | 7.40 |
|
155 |
+
| [llm-jp-3-3.7b-instruct](https://huggingface.co/llm-jp/llm-jp-3-3.7b-instruct) | 5.50 | 1.95 | 4.05 | 8.25 | 2.25 | 4.00 | 8.80 | 7.25 | 7.45 |
|
156 |
+
| [llm-jp-3-13b-instruct](https://huggingface.co/llm-jp/llm-jp-3-13b-instruct) | 6.47 | 3.15 | 7.05 | 9.15 | 3.75 | 5.40 | 8.30 | 7.50 | 7.45 |
|
157 |
+
|
158 |
+
|
159 |
+
|
160 |
+
## Risks and Limitations
|
161 |
+
|
162 |
+
The models released here are in the early stages of our research and development and have not been tuned to ensure outputs align with human intent and safety considerations.
|
163 |
+
|
164 |
+
|
165 |
+
## Send Questions to
|
166 |
+
|
167 |
+
llm-jp(at)nii.ac.jp
|
168 |
+
|
169 |
+
|
170 |
+
## License
|
171 |
+
|
172 |
+
[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
|
173 |
+
|
174 |
+
|
175 |
+
## Model Card Authors
|
176 |
+
|
177 |
+
Takashi Kodama.
|