burak commited on
Commit
5f90839
·
verified ·
1 Parent(s): eb8a33d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +49 -163
README.md CHANGED
@@ -7,197 +7,83 @@ language:
7
  - tr
8
  ---
9
 
10
- # Model Card for Model ID
11
 
12
- <!-- Provide a quick summary of what the model is/does. -->
13
 
 
14
 
 
 
 
 
 
 
15
 
16
- ## Model Details
17
 
18
- ### Model Description
19
 
20
- <!-- Provide a longer summary of what this model is. -->
 
 
 
 
21
 
22
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
23
 
24
- - **Developed by:** [More Information Needed]
25
- - **Funded by [optional]:** [More Information Needed]
26
- - **Shared by [optional]:** [More Information Needed]
27
- - **Model type:** [More Information Needed]
28
- - **Language(s) (NLP):** [More Information Needed]
29
- - **License:** [More Information Needed]
30
- - **Finetuned from model [optional]:** [More Information Needed]
31
 
32
- ### Model Sources [optional]
 
33
 
34
- <!-- Provide the basic links for the model. -->
35
 
36
- - **Repository:** [More Information Needed]
37
- - **Paper [optional]:** [More Information Needed]
38
- - **Demo [optional]:** [More Information Needed]
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
 
76
- Use the code below to get started with the model.
 
77
 
78
- [More Information Needed]
79
-
80
- ## Training Details
81
-
82
- ### Training Data
83
-
84
- <!-- 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. -->
85
-
86
- [More Information Needed]
87
-
88
- ### Training Procedure
89
-
90
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
91
-
92
- #### Preprocessing [optional]
93
-
94
- [More Information Needed]
95
-
96
-
97
- #### Training Hyperparameters
98
-
99
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
100
-
101
- #### Speeds, Sizes, Times [optional]
102
-
103
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
104
-
105
- [More Information Needed]
106
-
107
- ## Evaluation
108
-
109
- <!-- This section describes the evaluation protocols and provides the results. -->
110
-
111
- ### Testing Data, Factors & Metrics
112
-
113
- #### Testing Data
114
-
115
- <!-- This should link to a Dataset Card if possible. -->
116
-
117
- [More Information Needed]
118
-
119
- #### Factors
120
-
121
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
122
-
123
- [More Information Needed]
124
-
125
- #### Metrics
126
-
127
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
128
-
129
- [More Information Needed]
130
-
131
- ### Results
132
-
133
- [More Information Needed]
134
-
135
- #### Summary
136
-
137
-
138
-
139
- ## Model Examination [optional]
140
-
141
- <!-- Relevant interpretability work for the model goes here -->
142
-
143
- [More Information Needed]
144
-
145
- ## Environmental Impact
146
-
147
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
148
-
149
- 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).
150
-
151
- - **Hardware Type:** [More Information Needed]
152
- - **Hours used:** [More Information Needed]
153
- - **Cloud Provider:** [More Information Needed]
154
- - **Compute Region:** [More Information Needed]
155
- - **Carbon Emitted:** [More Information Needed]
156
-
157
- ## Technical Specifications [optional]
158
-
159
- ### Model Architecture and Objective
160
-
161
- [More Information Needed]
162
-
163
- ### Compute Infrastructure
164
-
165
- [More Information Needed]
166
-
167
- #### Hardware
168
-
169
- [More Information Needed]
170
-
171
- #### Software
172
-
173
- [More Information Needed]
174
-
175
- ## Citation [optional]
176
-
177
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
178
-
179
- **BibTeX:**
180
-
181
- [More Information Needed]
182
-
183
- **APA:**
184
-
185
- [More Information Needed]
186
-
187
- ## Glossary [optional]
188
-
189
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
190
-
191
- [More Information Needed]
192
-
193
- ## More Information [optional]
194
-
195
- [More Information Needed]
196
-
197
- ## Model Card Authors [optional]
198
-
199
- [More Information Needed]
200
-
201
- ## Model Card Contact
202
-
203
- [More Information Needed]
 
7
  - tr
8
  ---
9
 
10
+ # Model Card: SykoLLM-V1-Turkish
11
 
12
+ SykoLLM-V1-Turkish is a custom-architected, lightweight Large Language Model (LLM) designed specifically for Turkish conversational tasks. Unlike standard pre-built models, this version features a custom configuration optimized for speed and efficiency in low-resource environments.
13
 
14
+ ## Model Description
15
 
16
+ * **Developed by:** syko818121
17
+ * **Model Name:** SykoLLM-V1-Turkish
18
+ * **Model Type:** Causal Decoder-Only Custom Architecture
19
+ * **Language:** Turkish
20
+ * **Parameters:** ~50.8 Million
21
+ * **Training Data:** Turkish Wikipedia + Custom High-Quality Chat Dataset
22
 
23
+ ## Architectural Specs
24
 
25
+ This model uses a custom configuration designed for Turkish linguistics:
26
 
27
+ * **Vocabulary Size:** 50,257
28
+ * **Hidden Dimension (n_embd):** 512
29
+ * **Number of Layers:** 8
30
+ * **Attention Heads:** 8
31
+ * **Context Window:** 512 tokens
32
 
33
+ ## Fine-Tuning & Conversation Style
34
 
35
+ The model was fine-tuned on a high-quality, curated Turkish dataset to ensure natural, human-like responses. The training data distribution was carefully balanced:
 
 
 
 
 
 
36
 
37
+ *
38
+ **Greetings & Daily Talk (40%):** Natural openings and casual conversation.
39
 
 
40
 
41
+ *
42
+ **Direct Question-Answering (30%):** Short and concise answers to general knowledge queries.
 
43
 
 
44
 
45
+ *
46
+ **Brief Explanations (20%):** Simplified definitions for complex concepts.
47
 
 
48
 
49
+ *
50
+ **Slang & Short Inputs (10%):** Robustness against one-word or incomplete messages.
51
 
 
52
 
 
53
 
54
+ ## Usage
55
 
56
+ You can load and test SykoLLM-V1-Turkish using the following snippet:
57
 
58
+ ```python
59
+ from transformers import AutoModelForCausalLM, AutoTokenizer
60
 
61
+ model_id = "syko818121/SykoLLM-V1-Turkish"
62
+ tokenizer = AutoTokenizer.from_pretrained(model_id)
63
+ model = AutoModelForCausalLM.from_pretrained(model_id, trust_remote_code=True)
64
 
65
+ prompt = "<user> Selam, naber?<assistant>"
66
+ inputs = tokenizer(prompt, return_tensors="pt")
67
+ outputs = model.generate(**inputs, max_new_tokens=50, pad_token_id=tokenizer.eos_token_id)
68
 
69
+ print(tokenizer.decode(outputs[0], skip_special_tokens=True))
70
 
71
+ ```
72
 
73
+ ## Training Configuration
74
 
75
+ * **Learning Rate:** 5e-5
76
+ *
77
+ **Scheduler:** Cosine
78
 
 
79
 
80
+ * **Epochs:** 15
81
+ * **Batch Size:** 4
82
+ * **Precision:** FP16 (Mixed Precision)
83
 
84
+ ## Limitations
85
 
86
+ * **Size:** As a 50.8M parameter model, it is a "micro-LLM." It excels at short chats but may hallucinate on highly complex logical tasks.
87
+ * **Response Length:** The model is intentionally biased toward concise and direct answers rather than long-form essays.
88
 
89
+ ---