Merge pull request #31 from minggnim/update-readme

update readme

Author: minggnim

README.md

@@ -4,19 +4,31 @@
 
 # NLP Models
 
-A repository for training transformer based nlp models
+A repository for building transformer based nlp models
 
-## Example Notebooks
+## Models
 
-1. [Training](https://github.com/minggnim/nlp-classification-model/blob/master/notebooks/01_custom_training_example.ipynb)
-2. [Inference](https://github.com/minggnim/nlp-classification-model/blob/master/notebooks/02_inference_example.ipynb)
+1. bert_classifier
+   A wrapper package around BERT-based classification models
+   a. [Training example](https://github.com/minggnim/nlp-models/blob/master/notebooks/01_a_classification_model_training_example.ipynb)
+   b. [Inference example](https://github.com/minggnim/nlp-models/blob/master/notebooks/01_b_classification_inference_example.ipynb)
+2. multi_task_model
+   An implementation of multi-tasking model built on encoder models
+   a. [Zero-shot multi-task model](https://github.com/minggnim/nlp-models/blob/master/notebooks/02_a_multitask_model_zeroshot_learning.ipynb)
+   b. [Training example](https://github.com/minggnim/nlp-models/blob/master/notebooks/02_b_multitask_model_training_example.ipynb)
+   c. [Inference example](https://github.com/minggnim/nlp-models/blob/master/notebooks/02_c_multitask_model_inference_example.ipynb)
+
+## Other Example Notebooks
+
+- [Training GPT-2 model](https://github.com/minggnim/nlp-models/blob/master/notebooks/03_gpt2_training.ipynb)
+- [Running Falcon 4b model](https://github.com/minggnim/nlp-models/blob/master/notebooks/04_falcon_4b.ipynb)
 
 ## Installation
 
 ### Install from PyPi
 
 ```
-pip install nlp_models
+pip install nlp-models
 ```
 
 ### Install from source