makiisthebes commited on
Commit
aef8a31
1 Parent(s): 336cbca

Update README.md

Browse files

Updated Readme for the architecture.

Files changed (1) hide show
  1. README.md +60 -0
README.md CHANGED
@@ -1,3 +1,63 @@
1
  ---
2
  license: mit
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: mit
3
  ---
4
+
5
+ # Transformers from Scratch
6
+
7
+ <!-- Provide a quick summary of what the model is/does. -->
8
+ This project consists of code for Transformer Block, Single Head Attention and Multi-head attention and Casual Mask from Scratch.
9
+
10
+ ## Model Details
11
+
12
+ ### Model Description
13
+ <!-- Provide a longer summary of what this model is. -->
14
+ To solidify knowledge and for reference, attention block is based on paper "Attention is all you need".
15
+
16
+ ![image/png](https://cdn-uploads.huggingface.co/production/uploads/6319030647a84df2a5dd106c/DtZER9tQF37i2vSKXCS8k.png)
17
+
18
+ ![image/png](https://cdn-uploads.huggingface.co/production/uploads/6319030647a84df2a5dd106c/mSDuN8zci2QiZEvpQwIeM.png)
19
+
20
+ ![image/png](https://cdn-uploads.huggingface.co/production/uploads/6319030647a84df2a5dd106c/vHY84pugVJnx10TNTPAaz.png)
21
+
22
+
23
+ - **Developed by:** Michael Peres
24
+ - **Model type:** Vanilla Transformer from Scratch
25
+ - **Language(s) (NLP):** English
26
+ - **License:** MIT
27
+
28
+ ### Model Sources
29
+
30
+ <!-- Provide the basic links for the model. -->
31
+ - **Paper [Attention is all you need]:** https://arxiv.org/abs/1706.03762
32
+
33
+ ## Uses
34
+
35
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
36
+
37
+
38
+ [More Information Needed]
39
+
40
+
41
+ ## How to Get Started with the Model
42
+
43
+ Use the code below to get started with the model.
44
+
45
+ [More Information Needed]
46
+
47
+
48
+ ## Environmental Impact
49
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
50
+
51
+ 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).
52
+
53
+ - **Hardware Type:** RTX 3070Ti
54
+ - **Hours used:** 0.1hr
55
+
56
+
57
+ ### Model Architecture and Objective
58
+ Objective in this model was to understand Transformers, and the basic self attention module. Self Attention, Multi-Head Attention and Casual Mask and Transformer Block
59
+
60
+ ## Model Card Contact
61
+
62
+ - michaelperes1@gmail.com
63
+ - ec20433@qmul.ac.uk