Create README.md

README.md

@@ -0,0 +1,63 @@
+---
+license: mit
+---
+
+
+## How to use
+
+Requirements:
+
+```bash
+git clone https://github.com/ddevaul/transformers
+```
+
+```bash
+cd transformers
+```
+
+```bash
+pip install -r requirements.txt
+```
+
+```bash
+cd ..
+```
+
+Now open your file and add this:
+
+```python
+import sys
+import torch
+sys.path.append('./transformers/src')
+from torch.utils.checkpoint import checkpoint
+from transformers2 import BertConfig, BertTokenizer
+from transformers2.models.bert import BertForMaskedLM
+
+preload_path = 'cabrooks/character-level-logion'
+char_tokenizer = BertTokenizer.from_pretrained(preload_path)
+wordpiece_tokenizer = BertTokenizer.from_pretrained("cabrooks/LOGION-50k_wordpiece")
+config = BertConfig()
+config.word_piece_vocab_size = 50000
+config.vocab_size = char_tokenizer.vocab_size
+config.char_tokenizer = char_tokenizer
+config.wordpiece_tokenizer = wordpiece_tokenizer
+config.max_position_embeddings = 1024
+config.device2 = device
+model = BertForMaskedLM(config).to(device)
+```
+
+
+## Cite
+
+If you use this model in your research, please cite the paper:
+
+```
+@misc{logion-base,
+      title={Logion: Machine Learning for Greek Philology}, 
+      author={Cowen-Breen, C. and Brooks, C. and Haubold, J. and Graziosi, B.},
+      year={2023},
+      eprint={2305.01099},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL}
+}
+```