HODACHI commited on
Commit
d14b20b
1 Parent(s): 362eeb1

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +36 -172
README.md CHANGED
@@ -12,191 +12,55 @@ tags:
12
  ![image/png](https://cdn-uploads.huggingface.co/production/uploads/657e900beaad53ff67ba84db/uPWIuw_wAOwRk9O8qlZxZ.png)
13
 
14
 
15
- ## Model Details
 
16
 
17
- ### Model Description
18
 
19
- <!-- Provide a longer summary of what this model is. -->
20
 
21
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
 
22
 
23
- - **Developed by:** [More Information Needed]
24
- - **Funded by [optional]:** [More Information Needed]
25
- - **Shared by [optional]:** [More Information Needed]
26
- - **Model type:** [More Information Needed]
27
- - **Language(s) (NLP):** [More Information Needed]
28
- - **License:** [More Information Needed]
29
- - **Finetuned from model [optional]:** [More Information Needed]
30
 
31
- ### Model Sources [optional]
32
 
33
- <!-- Provide the basic links for the model. -->
 
34
 
35
- - **Repository:** [More Information Needed]
36
- - **Paper [optional]:** [More Information Needed]
37
- - **Demo [optional]:** [More Information Needed]
38
 
39
- ## Uses
40
 
41
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
42
 
43
- ### Direct Use
 
44
 
45
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
46
 
47
- [More Information Needed]
48
 
49
- ### Downstream Use [optional]
50
 
51
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
52
 
53
- [More Information Needed]
 
 
 
 
 
 
 
 
54
 
55
- ### Out-of-Scope Use
56
-
57
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
58
-
59
- [More Information Needed]
60
-
61
- ## Bias, Risks, and Limitations
62
-
63
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
64
-
65
- [More Information Needed]
66
-
67
- ### Recommendations
68
-
69
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
70
-
71
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
72
-
73
- ## How to Get Started with the Model
74
-
75
- Use the code below to get started with the model.
76
-
77
- [More Information Needed]
78
-
79
- ## Training Details
80
-
81
- ### Training Data
82
-
83
- <!-- 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. -->
84
-
85
- [More Information Needed]
86
-
87
- ### Training Procedure
88
-
89
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
90
-
91
- #### Preprocessing [optional]
92
-
93
- [More Information Needed]
94
-
95
-
96
- #### Training Hyperparameters
97
-
98
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
99
-
100
- #### Speeds, Sizes, Times [optional]
101
-
102
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
103
-
104
- [More Information Needed]
105
-
106
- ## Evaluation
107
-
108
- <!-- This section describes the evaluation protocols and provides the results. -->
109
-
110
- ### Testing Data, Factors & Metrics
111
-
112
- #### Testing Data
113
-
114
- <!-- This should link to a Dataset Card if possible. -->
115
-
116
- [More Information Needed]
117
-
118
- #### Factors
119
-
120
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
121
-
122
- [More Information Needed]
123
-
124
- #### Metrics
125
-
126
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
127
-
128
- [More Information Needed]
129
-
130
- ### Results
131
-
132
- [More Information Needed]
133
-
134
- #### Summary
135
-
136
-
137
-
138
- ## Model Examination [optional]
139
-
140
- <!-- Relevant interpretability work for the model goes here -->
141
-
142
- [More Information Needed]
143
-
144
- ## Environmental Impact
145
-
146
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
147
-
148
- 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).
149
-
150
- - **Hardware Type:** [More Information Needed]
151
- - **Hours used:** [More Information Needed]
152
- - **Cloud Provider:** [More Information Needed]
153
- - **Compute Region:** [More Information Needed]
154
- - **Carbon Emitted:** [More Information Needed]
155
-
156
- ## Technical Specifications [optional]
157
-
158
- ### Model Architecture and Objective
159
-
160
- [More Information Needed]
161
-
162
- ### Compute Infrastructure
163
-
164
- [More Information Needed]
165
-
166
- #### Hardware
167
-
168
- [More Information Needed]
169
-
170
- #### Software
171
-
172
- [More Information Needed]
173
-
174
- ## Citation [optional]
175
-
176
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
177
-
178
- **BibTeX:**
179
-
180
- [More Information Needed]
181
-
182
- **APA:**
183
-
184
- [More Information Needed]
185
-
186
- ## Glossary [optional]
187
-
188
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
189
-
190
- [More Information Needed]
191
-
192
- ## More Information [optional]
193
-
194
- [More Information Needed]
195
-
196
- ## Model Card Authors [optional]
197
-
198
- [More Information Needed]
199
-
200
- ## Model Card Contact
201
-
202
- [More Information Needed]
 
12
  ![image/png](https://cdn-uploads.huggingface.co/production/uploads/657e900beaad53ff67ba84db/uPWIuw_wAOwRk9O8qlZxZ.png)
13
 
14
 
15
+ ## [Model Information]
16
+ Based on phi-3.5-mini-Instruct, this model is a general-purpose model with improved performance from the base model after employing multiple tuning methods. In particular, Japanese language performance has been improved.
17
 
18
+ phi-3.5-mini-Instructをベースとして、複数のチューニング手法を採用のうえ、汎用的にベースモデルから性能を向上させたモデルです。特に日本語性能が向上しています。
19
 
 
20
 
21
+ ### [Benchmark Results]
22
+ TODO:
23
 
24
+ ### 推奨される使用ガイドライン / Recommended Usage Guidelines
 
 
 
 
 
 
25
 
26
+ 1. **商用利用**: 本モデルを商用目的で使用する場合、info@axcxept.com へのメール連絡を強く推奨します。これにより、モデルの応用や改善についての協力の機会が生まれる可能性があります。
27
 
28
+ 2. **クレジット表記**: 本モデルを使用または改変する際は、以下のようなクレジット表記を行うことを推奨します:
29
+ "This project utilizes HODACHI/Borea-Phi-3.5-mini-Instruct-Jp, a model based on Phi-3.5-mini-Instruct and fine-tuned by Axcxept co., ltd."
30
 
31
+ 3. **フィードバック**: モデルの使用経験に関するフィードバックを歓迎します。info@axcxept.com までご連絡ください。
 
 
32
 
33
+ これらは推奨事項であり、法的要件ではありません。
34
 
35
+ 1. **Commercial Use**: If you plan to use this model for commercial purposes, we strongly encourage you to inform us via email at info@axcxept.com. This allows for potential collaboration on model applications and improvements.
36
 
37
+ 2. **Attribution**: When using or adapting this model, we recommend providing attribution as follows:
38
+ "This project utilizes HODACHI/Borea-Phi-3.5-mini-Instruct-Jp, a model based on Phi-3.5-mini-Instruct and fine-tuned by Axcxept co., ltd."
39
 
40
+ 3. **Feedback**: We welcome any feedback on your experience with the model. Please feel free to email us at info@axcxept.com.
41
 
42
+ Please note that these are recommendations and not legal requirements.
43
 
 
44
 
45
+ ### [Usage]
46
 
47
+ Here are some code snippets to quickly get started with the model. First, run:
48
+ ```bash
49
+ pip install flash_attn==2.5.8
50
+ pip install accelerate==0.31.0
51
+ pip install transformers==4.43.0
52
+ pip install -U trl
53
+ pip install pytest
54
+ ```
55
+ Then, copy the snippet from the relevant section for your use case.
56
 
57
+ 以下に、モデルの実行を素早く開始するためのコードスニペットをいくつか紹介します。
58
+ まず、
59
+ ```bash
60
+ pip install flash_attn==2.5.8
61
+ pip install accelerate==0.31.0
62
+ pip install transformers==4.43.0
63
+ pip install -U trl
64
+ pip install pytest
65
+ ```
66
+ を実行し、使用例に関連するセクションのスニペットをコピーしてください。