README initial commit

README.md

@@ -1,3 +1,32 @@
 ---
+language:
+- zh
+tags:
+- Transformer
+- korean
+- romanization
+- person name
+- 한국어
 license: cc-by-nc-sa-4.0
 ---
+
+# <font color="IndianRed"> BertForSequenceClassification model (Classical Chinese) </font>
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1jVu2LrNwkLolItPALKGNjeT6iCfzF8Ic?usp=sharing/)
+
+This Korean-person-name-romanization-transformer model is intended to convert Korean person name into English romanization. The model's input sentence is a Korean name, and the output sentence is its corresponding English romanization. 
+
+## <font color="IndianRed"> Model description </font>
+
+The transformer model has an encoder and a decoder, in which the encoder takes a sentence in the source language and the decoder outputs it into the target language. 
+
+## <font color="IndianRed"> Intended uses & limitations </font>
+
+Note that this model primarily aims at translating Korean names into English romanization.
+
+### <font color="IndianRed"> How to use </font>
+
+Here is how to use this model to get the features of a given text in PyTorch:
+
+<font color="cornflowerblue"> 1. Import model and packages </font>
+
+to be finished...