printr commited on
Commit
11059cc
1 Parent(s): eb16608

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +20 -0
README.md CHANGED
@@ -1,3 +1,23 @@
1
  ---
2
  license: cc-by-2.0
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: cc-by-2.0
3
  ---
4
+
5
+ ### Features
6
+ - Just like GPT this model generates text based on an input prompt.
7
+ - This project uses Reinforcement Learning (RL) for training and inference.
8
+ - All models can be found on hugging face.
9
+
10
+ ---
11
+
12
+ ### Training
13
+
14
+ - First step is to run ``generate_vocab.py`` on whatever text data you would like to train on for example ``python3 generate_vocab.py -i train.txt``
15
+ - Next step is to run ``train.py``
16
+ - Now all you have to do is wait!
17
+ ---
18
+ ### Inference
19
+
20
+ - not fully complete but inferect can be removed from ``train.py`` and put into its own script.
21
+
22
+ ### Logging
23
+ - Output plot graphs will be avalible in the next version.