HODACHI commited on
Commit
15f7c17
1 Parent(s): 55a1994

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +78 -163
README.md CHANGED
@@ -1,199 +1,114 @@
1
  ---
 
2
  library_name: transformers
3
- tags: []
 
 
 
 
 
 
 
 
4
  ---
5
 
6
- # Model Card for Model ID
7
 
8
- <!-- Provide a quick summary of what the model is/does. -->
9
 
 
10
 
 
 
 
11
 
12
- ## Model Details
13
 
14
- ### Model Description
15
 
16
- <!-- Provide a longer summary of what this model is. -->
17
 
18
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
19
 
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
 
28
- ### Model Sources [optional]
29
 
30
- <!-- Provide the basic links for the model. -->
31
 
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
 
36
- ## Uses
37
 
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
 
 
 
39
 
40
- ### Direct Use
41
 
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 
 
 
43
 
44
- [More Information Needed]
 
45
 
46
- ### Downstream Use [optional]
 
 
 
 
47
 
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
 
 
 
 
 
 
49
 
50
- [More Information Needed]
51
 
52
- ### Out-of-Scope Use
 
 
 
 
 
 
53
 
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
 
56
- [More Information Needed]
 
 
 
 
 
 
 
 
 
57
 
58
- ## Bias, Risks, and Limitations
59
 
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
 
62
- [More Information Needed]
63
 
64
- ### Recommendations
 
 
65
 
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
 
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
 
70
- ## How to Get Started with the Model
71
 
72
- Use the code below to get started with the model.
 
73
 
74
- [More Information Needed]
75
 
76
- ## Training Details
77
-
78
- ### Training Data
79
-
80
- <!-- 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. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
-
103
- ## Evaluation
104
-
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- 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).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
-
161
- [More Information Needed]
162
-
163
- #### Hardware
164
-
165
- [More Information Needed]
166
-
167
- #### Software
168
-
169
- [More Information Needed]
170
-
171
- ## Citation [optional]
172
-
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
-
175
- **BibTeX:**
176
-
177
- [More Information Needed]
178
-
179
- **APA:**
180
-
181
- [More Information Needed]
182
-
183
- ## Glossary [optional]
184
-
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
-
187
- [More Information Needed]
188
-
189
- ## More Information [optional]
190
-
191
- [More Information Needed]
192
-
193
- ## Model Card Authors [optional]
194
-
195
- [More Information Needed]
196
-
197
- ## Model Card Contact
198
-
199
- [More Information Needed]
 
1
  ---
2
+ license: gemma
3
  library_name: transformers
4
+ pipeline_tag: text-generation
5
+ extra_gated_heading: Access Gemma on Hugging Face
6
+ extra_gated_prompt: >-
7
+ To access Gemma on Hugging Face, you’re required to review and agree to
8
+ Google’s usage license. To do this, please ensure you’re logged in to Hugging
9
+ Face and click below. Requests are processed immediately.
10
+ extra_gated_button_content: Acknowledge license
11
+ tags:
12
+ - conversational
13
  ---
14
 
 
15
 
16
+ # EZO model card
17
 
18
+ **Resources and Technical Documentation**:
19
 
20
+ * [Responsible Generative AI Toolkit][rai-toolkit]
21
+ * [Gemma on Kaggle][kaggle-gemma]
22
+ * [Gemma on Vertex Model Garden][vertex-mg-gemma]
23
 
24
+ **Terms of Use**: [Terms](https://www.kaggle.com/models/google/gemma/license/consent/verify/huggingface?returnModelRepoId=google/gemma-2-9b-it)
25
 
26
+ **Authors**: Axcxept co., ltd.
27
 
28
+ ## Model Information
29
 
30
+ ### Description
31
 
32
+ Gemma-2-9B-itをベースとして、複数のチューニング手法を採用のうえ、特にHumanitiesに特化させたモデルです。
 
 
 
 
 
 
33
 
34
+ ### Benchmark Results
35
 
36
+ ![image/png](https://cdn-uploads.huggingface.co/production/uploads/657e900beaad53ff67ba84db/pFHVX7j4nd__jKdhari8w.png)
37
 
 
 
 
38
 
39
+ ### Usage
40
 
41
+ 以下に、モデルの実行を素早く開始するためのコードスニペットをいくつか紹介します。
42
+ まず、
43
+ `pip install -U transformers`
44
+ を実行し、使用例に関連するセクションのスニペットをコピーしてください。
45
 
46
+ ### Chat Template
47
 
48
+ ```py
49
+ from transformers import AutoTokenizer, AutoModelForCausalLM
50
+ import transformers
51
+ import torch
52
 
53
+ model_id = "google/gemma-2-9b-it"
54
+ dtype = torch.bfloat16
55
 
56
+ tokenizer = AutoTokenizer.from_pretrained(model_id)
57
+ model = AutoModelForCausalLM.from_pretrained(
58
+ model_id,
59
+ device_map="cuda",
60
+ torch_dtype=dtype,)
61
 
62
+ chat = [
63
+ { "role": "user", "content": "Write a hello world program" },
64
+ ]
65
+ prompt = tokenizer.apply_chat_template(chat, tokenize=False, add_generation_prompt=True)
66
+ inputs = tokenizer.encode(prompt, add_special_tokens=False, return_tensors="pt")
67
+ outputs = model.generate(input_ids=inputs.to(model.device), max_new_tokens=150)
68
+ print(tokenizer.decode(outputs[0]))
69
 
70
+ ```
71
 
72
+ ### Template
73
+ ```
74
+ <bos><start_of_turn>user
75
+ Write a hello world program<end_of_turn>
76
+ <start_of_turn>model
77
+ XXXXXX<end_of_turn><eos>
78
+ ```
79
 
80
+ ### Citation
81
 
82
+ ```none
83
+ @article{gemma_2024,
84
+ title={Gemma},
85
+ url={https://www.kaggle.com/m/3301},
86
+ DOI={10.34740/KAGGLE/M/3301},
87
+ publisher={Kaggle},
88
+ author={Gemma Team},
89
+ year={2024}
90
+ }
91
+ ```
92
 
93
+ ## Model Data
94
 
95
+ Data used for model training and how the data was processed.
96
 
97
+ ### Training Dataset
98
 
99
+ 日本語のWikiデータおよび、FineWebから良質なデータのみを抽出し、Instructionデータを作成しました。
100
+ https://huggingface.co/datasets/legacy-datasets/wikipedia
101
+ https://huggingface.co/datasets/HuggingFaceFW/fineweb
102
 
103
+ ### Data Preprocessing
104
 
105
+ プレインストラクトチューニング手法を用いて、模範的回答を学習させました。
106
 
107
+ ## Implementation Information
108
 
109
+ [Pre-Instruction Training]
110
+ https://huggingface.co/instruction-pretrain/instruction-synthesizer
111
 
112
+ ### Hardware
113
 
114
+ A100 × 4 × 32H