Deepmalya25 commited on
Commit
9261167
·
verified ·
1 Parent(s): 86b9e77

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +191 -0
README.md CHANGED
@@ -1,3 +1,194 @@
1
  ---
2
  license: mit
 
 
 
 
 
 
 
 
 
 
 
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: mit
3
+ datasets:
4
+ - karpathy/tiny_shakespeare
5
+ language:
6
+ - en
7
+ metrics:
8
+ - accuracy
9
+ base_model:
10
+ - Bigram-Language-Model
11
+ tags:
12
+ - Transformer
13
+ - GPT
14
+ - Decoder-only
15
  ---
16
+ # Model Card for Model ID
17
+
18
+ <!-- Provide a quick summary of what the model is/does. -->
19
+
20
+ This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
21
+
22
+ ## Model Details
23
+
24
+ This model recreates the GPT architecture scaled down just to 10.8M parameters. This Model is build entirely from Scratch.
25
+
26
+ ### Model Description
27
+
28
+ <!-- Provide a longer summary of what this model is. -->
29
+
30
+
31
+
32
+ - **Developed by:** [Deepmalya Koley]
33
+ - **Funded by [optional]:** [More Information Needed]
34
+ - **Inspired by [optional]:** [Andrej Karpathy]
35
+ - **Model type:** [Transformer]
36
+ - **Language(s) (NLP):** [Decoder only]
37
+ - **License:** [MIT]
38
+ - **Evolved from model [optional]:** [BigramLanguageModel]
39
+
40
+ ### Model Sources [optional]
41
+
42
+ <!-- Provide the basic links for the model. -->
43
+
44
+ - **Repository:** [(https://github.com/Deepmalya2506/From-Kernel-to-Silicon---Transformers)]
45
+ - **Paper [optional]:** [More Information Needed]
46
+ - **Demo [optional]:** [More Information Needed]
47
+
48
+ ## Uses
49
+
50
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
51
+ The Model replicates the exact same Decoder only Transformer architecture used in GPT. However this model is trained over 5000 epochs with Parallely processed batches of 328 vectors to predict the next token in the subsequent timestep
52
+
53
+ ## Bias, Risks, and Limitations
54
+
55
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
56
+
57
+ [The Model is a scaled down version of actual GPT architecture build entirely from scratch. It has only 10.8M params unlike GPT with Billions. The model doesnot incorporate autoregressive processings ]
58
+
59
+ ### Recommendations
60
+
61
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
62
+
63
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
64
+
65
+ ## How to Get Started with the Model
66
+
67
+ Use the code below to get started with the model.
68
+
69
+ [More Information Needed]
70
+
71
+ ## Training Details
72
+
73
+ ### Training Data
74
+
75
+ <!-- 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. -->
76
+
77
+ [More Information Needed]
78
+
79
+ ### Training Procedure
80
+
81
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
82
+
83
+ #### Preprocessing [optional]
84
+
85
+ [More Information Needed]
86
+
87
+
88
+ #### Training Hyperparameters
89
+
90
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
91
+
92
+ #### Speeds, Sizes, Times [optional]
93
+
94
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
95
+
96
+ [More Information Needed]
97
+
98
+ ## Evaluation
99
+
100
+ <!-- This section describes the evaluation protocols and provides the results. -->
101
+
102
+ ### Testing Data, Factors & Metrics
103
+
104
+ #### Testing Data
105
+
106
+ <!-- This should link to a Dataset Card if possible. -->
107
+
108
+ [More Information Needed]
109
+
110
+ #### Factors
111
+
112
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
113
+
114
+ [More Information Needed]
115
+
116
+ #### Metrics
117
+
118
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
119
+
120
+ [More Information Needed]
121
+
122
+ ### Results
123
+
124
+ [More Information Needed]
125
+
126
+ #### Summary
127
+
128
+
129
+
130
+ ## Model Examination [optional]
131
+
132
+ <!-- Relevant interpretability work for the model goes here -->
133
+
134
+ [More Information Needed]
135
+
136
+ ## Environmental Impact
137
+
138
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
139
+
140
+ 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).
141
+
142
+ - **Hardware Type:** [More Information Needed]
143
+ - **Hours used:** [More Information Needed]
144
+ - **Cloud Provider:** [More Information Needed]
145
+ - **Compute Region:** [More Information Needed]
146
+ - **Carbon Emitted:** [More Information Needed]
147
+
148
+ ## Technical Specifications [optional]
149
+
150
+ ### Model Architecture and Objective
151
+
152
+ [More Information Needed]
153
+
154
+ ### Compute Infrastructure
155
+
156
+ [More Information Needed]
157
+
158
+ #### Hardware
159
+
160
+ [More Information Needed]
161
+
162
+ #### Software
163
+
164
+ [More Information Needed]
165
+
166
+ ## Citation [optional]
167
+
168
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
169
+
170
+ **BibTeX:**
171
+
172
+ [More Information Needed]
173
+
174
+ **APA:**
175
+
176
+ [More Information Needed]
177
+
178
+ ## Glossary [optional]
179
+
180
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
181
+
182
+ [More Information Needed]
183
+
184
+ ## More Information [optional]
185
+
186
+ [More Information Needed]
187
+
188
+ ## Model Card Authors [optional]
189
+
190
+ [More Information Needed]
191
+
192
+ ## Model Card Contact
193
+
194
+ [More Information Needed]