cenkersisman commited on
Commit
ca349a4
1 Parent(s): 772b79a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +205 -1
README.md CHANGED
@@ -8,4 +8,208 @@ language:
8
 
9
  # Model Card for Model ID
10
 
11
- kelime(ler) yazıp kurduğu oluşturduğu cümlelerin yapısını gözlemleyebilirsiniz.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8
 
9
  # Model Card for Model ID
10
 
11
+ Model Card for GPT-2 Turkish Model
12
+
13
+
14
+ ## Model Details
15
+
16
+ ### Model Description
17
+
18
+ GPT-2 Turkish Model is a language model based on the GPT-2 architecture, fine-tuned for the Turkish language. It is capable of generating human-like text based on a given prompt and has been trained on a large corpus of Turkish text data.
19
+
20
+
21
+
22
+ - **Developed by:** Cenker Sisman
23
+ - **Model type:** [More Information Needed]
24
+ - **Language(s) (NLP):** [More Information Needed]
25
+ - **License:** [More Information Needed]
26
+ - **Finetuned from model :GPT-2
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
+
37
+
38
+ ## Sınırlamalar ve Önyargılar
39
+
40
+ ## Uses
41
+
42
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
43
+
44
+ ### Direct Use
45
+
46
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
47
+
48
+ [More Information Needed]
49
+
50
+ ### Downstream Use [optional]
51
+
52
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
53
+
54
+ [More Information Needed]
55
+
56
+ ### Out-of-Scope Use
57
+
58
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
59
+
60
+ [More Information Needed]
61
+
62
+ ## Bias, Risks, and Limitations
63
+
64
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
65
+
66
+ [More Information Needed]
67
+
68
+ ### Recommendations
69
+
70
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
71
+
72
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
73
+
74
+ ## How to Get Started with the Model
75
+ ```python
76
+ """Inference"""
77
+ # Example code for inference with the model
78
+
79
+ from transformers import GPT2Tokenizer, GPT2LMHeadModel
80
+
81
+ model_name = "cenker-sisman/gpt2-turkish-small" # Change to the model name you have uploaded to Hugging Face
82
+ tokenizer = GPT2Tokenizer.from_pretrained(model_name)
83
+ model = GPT2LMHeadModel.from_pretrained(model_name)
84
+
85
+ prompt = "Merhaba, nasılsınız?"
86
+ input_ids = tokenizer.encode(prompt, return_tensors="pt")
87
+ output = model.generate(input_ids, max_length=100, pad_token_id=tokenizer.eos_token_id)
88
+ generated_text = tokenizer.decode(output[0], skip_special_tokens=True)
89
+ print(generated_text)
90
+
91
+ ```
92
+ ## Training Details
93
+
94
+ ### Training Data
95
+
96
+ <!-- This should link to a Data 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. -->
97
+
98
+ [More Information Needed]
99
+
100
+ ### Training Procedure
101
+
102
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
103
+
104
+ #### Preprocessing [optional]
105
+
106
+ [More Information Needed]
107
+
108
+
109
+ #### Training Hyperparameters
110
+
111
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
112
+
113
+ #### Speeds, Sizes, Times [optional]
114
+
115
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
116
+
117
+ [More Information Needed]
118
+
119
+ ## Evaluation
120
+
121
+ <!-- This section describes the evaluation protocols and provides the results. -->
122
+
123
+ ### Testing Data, Factors & Metrics
124
+
125
+ #### Testing Data
126
+
127
+ <!-- This should link to a Data Card if possible. -->
128
+
129
+ [More Information Needed]
130
+
131
+ #### Factors
132
+
133
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
134
+
135
+ [More Information Needed]
136
+
137
+ #### Metrics
138
+
139
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
140
+
141
+ [More Information Needed]
142
+
143
+ ### Results
144
+
145
+ [More Information Needed]
146
+
147
+ #### Summary
148
+
149
+
150
+
151
+ ## Model Examination [optional]
152
+
153
+ <!-- Relevant interpretability work for the model goes here -->
154
+
155
+ [More Information Needed]
156
+
157
+ ## Environmental Impact
158
+
159
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
160
+
161
+ 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).
162
+
163
+ - **Hardware Type:** [More Information Needed]
164
+ - **Hours used:** [More Information Needed]
165
+ - **Cloud Provider:** [More Information Needed]
166
+ - **Compute Region:** [More Information Needed]
167
+ - **Carbon Emitted:** [More Information Needed]
168
+
169
+ ## Technical Specifications [optional]
170
+
171
+ ### Model Architecture and Objective
172
+
173
+ [More Information Needed]
174
+
175
+ ### Compute Infrastructure
176
+
177
+ [More Information Needed]
178
+
179
+ #### Hardware
180
+
181
+ [More Information Needed]
182
+
183
+ #### Software
184
+
185
+ [More Information Needed]
186
+
187
+ ## Citation [optional]
188
+
189
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
190
+
191
+ **BibTeX:**
192
+
193
+ [More Information Needed]
194
+
195
+ **APA:**
196
+
197
+ [More Information Needed]
198
+
199
+ ## Glossary [optional]
200
+
201
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
202
+
203
+ [More Information Needed]
204
+
205
+ ## More Information [optional]
206
+
207
+ [More Information Needed]
208
+
209
+ ## Model Card Authors [optional]
210
+
211
+ [More Information Needed]
212
+
213
+ ## Model Card Contact
214
+
215
+ [More Information Needed]