Antonio88 commited on
Commit
bf29e5c
1 Parent(s): 0aa8e1f

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +40 -156
README.md CHANGED
@@ -1,199 +1,83 @@
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
+ language:
3
+ - en
4
+ - it
5
+ license: mit
6
+ tags:
7
+ - Conversational
8
+ base_model: microsoft/Phi-3-mini-128k-instruct
9
+ datasets:
10
+ - Antonio88/TaliStran-DataSet
11
  library_name: transformers
 
12
  ---
13
 
 
14
 
 
15
 
16
 
17
+ ![image/jpeg](https://cdn-uploads.huggingface.co/production/uploads/644fc68af8b353c9491785d8/77Dgq3OyiomZDoZxplyqy.jpeg)
18
 
 
19
 
 
20
 
 
21
 
 
22
 
 
 
 
 
 
 
 
23
 
24
+ ## Responsible AI Considerations for the Phi3stran Models
25
 
26
+ Like other language models, the Phi series can potentially exhibit behaviors that are unfair, unreliable, or offensive. It’s important to be aware of some limiting behaviors:
27
 
28
+ Quality of Service: The Phi models are primarily trained on Italian text. Performance may degrade for languages other than Italian.
 
 
29
 
30
+ Representation of Harms & Perpetuation of Stereotypes: These models can over- or under-represent certain groups of people, erase representation of some groups, or reinforce demeaning or negative stereotypes. Despite post-training safety measures, these limitations may persist due to varying levels of representation of different groups or the prevalence of negative stereotypes in the training data that reflect real-world patterns and societal biases.
31
 
32
+ Inappropriate or Offensive Content: The models may generate content that is inappropriate or offensive, which could make them unsuitable for deployment in sensitive contexts without additional, use-case-specific mitigations.
33
 
34
+ Information Reliability: Language models can produce nonsensical or fabricated content that may seem plausible but is inaccurate or outdated.
35
 
36
+ Limited Scope for Code: The majority of Phi-3 training data is based on Python and utilizes common packages such as “typing, math, random, collections, datetime, itertools”. If the model generates Python scripts that use other packages or scripts in other languages, manual verification of all API uses is strongly recommended.
37
 
38
+ Developers should employ responsible AI best practices and ensure compliance with relevant laws and regulations (e.g., privacy, trade, etc.) for their specific use cases.
39
 
40
+ Model in Test: Continuous improvements are being made to the model.
41
 
42
+ Please note that the responses from the model should not be regarded as absolute truths.
43
 
 
44
 
45
+ ## Prompt Template:
46
 
47
+ ** Use Phi 3 model preset.
48
 
49
+ Prompt template:
50
 
51
+ <|system|>
52
+ {system_prompt}.<|end|>
53
+ <|user|>
54
+ {prompt}<|end|>
55
+ <|assistant|>
56
 
 
57
 
 
58
 
59
+ # Downloading and running the models
60
 
61
+ You can download the individual files from the Files & versions section.
62
 
63
+ | Quant type | Download |
64
+ |------------|--------------------------------------------------------------------------------------------|
65
+ | Q5_K_M | PHI3STRAN-GGUF [here](https://huggingface.co/Antonio88/PHI3STRAN-128K-ITA-V.0.1-Q5_K_M.GGUF) |
66
 
 
67
 
 
68
 
69
+ ## How to Download GGUF Files Manually?
70
 
71
+ Note for Manual Downloaders:
72
 
73
+ The following clients will automatically download models for you, providing a list of available models to choose from:
74
 
75
+ LM Studio
76
 
77
+ Use PHI3 config.preset
78
 
 
79
 
 
80
 
81
+ ## Credits & License
82
 
83
+ The license of the smashed model follows the license of the original model. Please check the license of the original model before using this model which provided the base model.