add reame

Author: js1010

README.md

@@ -24,7 +24,14 @@ python setup.py install
 
 ### How to use
 
-- `examples/example1.py` and `examples/README.md` will be very helpful to understand the usage.
+- `examples/example_w2v.py`, `examples/example_lda.py` and `examples/README.md` will be very helpful to understand the usage.
 - paremeter description can be seen in `cusim/proto/config.proto`
 
 ### Performance
+
+
+### Future tasks
+
+- support half precision
+- support multi device (multi device implementation on LDA model will not be that hard, while multi device training on w2v may require some considerations)
+- implement other models such as FastText, BERT, etc

examples/README.md

@@ -0,0 +1,21 @@
+### How to run example code
+
+0. install requirements
+
+```shell
+pip install -r requirements.txt
+```
+
+1. first, it is good to know about python-fire in https://github.com/google/python-fire, if you haven't heard yet.
+
+2. run w2v experiments on various setting (e.g. skip gram with hierarchical softmax)
+
+```shell
+python example_w2v.py run_experiments --sg0=True --hs0=True
+```
+
+7. run lda experiments 
+
+```shell
+python example_lda.py run_experiments
+```