added README and refactor

wangstar0211 · Apr 27, 2019 · cf2175e · cf2175e
1 parent 7ce2c16
commit cf2175e
Show file tree

Hide file tree

Showing 54 changed files with 30 additions and 13 deletions.
diff --git a/abstractive-summarization/README.md b/abstractive-summarization/README.md
@@ -1,3 +1,5 @@
 ## How-to
 
-1. Unzip dataset.tar.gz
+1. Unzip [dataset.tar.gz](dataset.tar.gz)
+
+2. Run any notebook using Jupyter Notebook.
diff --git a/chatbot/README.md b/chatbot/README.md
@@ -2,7 +2,7 @@
 
 1. Unzip [dataset.tar.gz](dataset.tar.gz)
 
-2. Run any notebooks.
+2. Run any notebook using Jupyter Notebook.
 
 ## Accuracy, not sorted
 

diff --git a/...parison/Deep-learning/LNLSTM-vector.ipynb → ...parison/Deep-learning/LNLSTM-vector.ipynb b/...parison/Deep-learning/LNLSTM-vector.ipynb → ...parison/Deep-learning/LNLSTM-vector.ipynb
diff --git a/...p-learning/bidirectional-rnn-vector.ipynb → ...p-learning/bidirectional-rnn-vector.ipynb b/...p-learning/bidirectional-rnn-vector.ipynb → ...p-learning/bidirectional-rnn-vector.ipynb
diff --git a/...arison/Deep-learning/cnn-rnn-vector.ipynb → ...arison/Deep-learning/cnn-rnn-vector.ipynb b/...arison/Deep-learning/cnn-rnn-vector.ipynb → ...arison/Deep-learning/cnn-rnn-vector.ipynb
diff --git a/...Comparison/Deep-learning/cnn-vector.ipynb → ...comparison/Deep-learning/cnn-vector.ipynb b/...Comparison/Deep-learning/cnn-vector.ipynb → ...comparison/Deep-learning/cnn-vector.ipynb
diff --git a/...on/Deep-learning/feedforward-vector.ipynb → ...on/Deep-learning/feedforward-vector.ipynb b/...on/Deep-learning/feedforward-vector.ipynb → ...on/Deep-learning/feedforward-vector.ipynb
diff --git a/...ison/Deep-learning/kmax-conv-vector.ipynb → ...ison/Deep-learning/kmax-conv-vector.ipynb b/...ison/Deep-learning/kmax-conv-vector.ipynb → ...ison/Deep-learning/kmax-conv-vector.ipynb
diff --git a/...n/Deep-learning/multihead-attention.ipynb → ...n/Deep-learning/multihead-attention.ipynb b/...n/Deep-learning/multihead-attention.ipynb → ...n/Deep-learning/multihead-attention.ipynb
diff --git a/...Comparison/Deep-learning/ntm-vector.ipynb → ...comparison/Deep-learning/ntm-vector.ipynb b/...Comparison/Deep-learning/ntm-vector.ipynb → ...comparison/Deep-learning/ntm-vector.ipynb
diff --git a/...Deep-learning/only-attention-vector.ipynb → ...Deep-learning/only-attention-vector.ipynb b/...Deep-learning/only-attention-vector.ipynb → ...Deep-learning/only-attention-vector.ipynb
diff --git a/.../Deep-learning/rnn-attention-vector.ipynb → .../Deep-learning/rnn-attention-vector.ipynb b/.../Deep-learning/rnn-attention-vector.ipynb → .../Deep-learning/rnn-attention-vector.ipynb
diff --git a/...parison/Deep-learning/rnn-timestamp.ipynb → ...parison/Deep-learning/rnn-timestamp.ipynb b/...parison/Deep-learning/rnn-timestamp.ipynb → ...parison/Deep-learning/rnn-timestamp.ipynb
diff --git a/...ison/Deep-learning/rnn-vector-hinge.ipynb → ...ison/Deep-learning/rnn-vector-hinge.ipynb b/...ison/Deep-learning/rnn-vector-hinge.ipynb → ...ison/Deep-learning/rnn-vector-hinge.ipynb
diff --git a/...ison/Deep-learning/rnn-vector-huber.ipynb → ...ison/Deep-learning/rnn-vector-huber.ipynb b/...ison/Deep-learning/rnn-vector-huber.ipynb → ...ison/Deep-learning/rnn-vector-huber.ipynb
diff --git a/...ison/Deep-learning/rnn-vector-stack.ipynb → ...ison/Deep-learning/rnn-vector-stack.ipynb b/...ison/Deep-learning/rnn-vector-stack.ipynb → ...ison/Deep-learning/rnn-vector-stack.ipynb
diff --git a/...Comparison/Deep-learning/rnn-vector.ipynb → ...comparison/Deep-learning/rnn-vector.ipynb b/...Comparison/Deep-learning/rnn-vector.ipynb → ...comparison/Deep-learning/rnn-vector.ipynb
diff --git a/...elf-optimized-feedforward-timestamp.ipynb → ...elf-optimized-feedforward-timestamp.ipynb b/...elf-optimized-feedforward-timestamp.ipynb → ...elf-optimized-feedforward-timestamp.ipynb
diff --git a/...Deep-learning/seq2seq-vector-stable.ipynb → ...Deep-learning/seq2seq-vector-stable.ipynb b/...Deep-learning/seq2seq-vector-stable.ipynb → ...Deep-learning/seq2seq-vector-stable.ipynb
diff --git a/...arison/Deep-learning/seq2seq-vector.ipynb → ...arison/Deep-learning/seq2seq-vector.ipynb b/...arison/Deep-learning/seq2seq-vector.ipynb → ...arison/Deep-learning/seq2seq-vector.ipynb
diff --git a/...parison/Ensemble/featuring-ensemble.ipynb → ...parison/Ensemble/featuring-ensemble.ipynb b/...parison/Ensemble/featuring-ensemble.ipynb → ...parison/Ensemble/featuring-ensemble.ipynb
diff --git a/...fication Comparison/Ensemble/oracle.ipynb → ...fication-comparison/Ensemble/oracle.ipynb b/...fication Comparison/Ensemble/oracle.ipynb → ...fication-comparison/Ensemble/oracle.ipynb
diff --git a/...tion Comparison/LGB/lgb-tfidf-svd50.ipynb → ...tion-comparison/LGB/lgb-tfidf-svd50.ipynb b/...tion Comparison/LGB/lgb-tfidf-svd50.ipynb → ...tion-comparison/LGB/lgb-tfidf-svd50.ipynb
diff --git a/...sification Comparison/LGB/lgb-tfidf.ipynb → ...sification-comparison/LGB/lgb-tfidf.ipynb b/...sification Comparison/LGB/lgb-tfidf.ipynb → ...sification-comparison/LGB/lgb-tfidf.ipynb
diff --git a/...cation Comparison/LGB/lgb-timestamp.ipynb → ...cation-comparison/LGB/lgb-timestamp.ipynb b/...cation Comparison/LGB/lgb-timestamp.ipynb → ...cation-comparison/LGB/lgb-timestamp.ipynb
diff --git a/...ation Comparison/LGB/nce-vector-lgb.ipynb → ...ation-comparison/LGB/nce-vector-lgb.ipynb b/...ation Comparison/LGB/nce-vector-lgb.ipynb → ...ation-comparison/LGB/nce-vector-lgb.ipynb
diff --git a/...sification Comparison/NB-SVM/NB-SVM.ipynb → ...sification-comparison/NB-SVM/NB-SVM.ipynb b/...sification Comparison/NB-SVM/NB-SVM.ipynb → ...sification-comparison/NB-SVM/NB-SVM.ipynb
diff --git a/...arison/Naive-Bayes/Bayes classifier.ipynb → ...arison/Naive-Bayes/Bayes classifier.ipynb b/...arison/Naive-Bayes/Bayes classifier.ipynb → ...arison/Naive-Bayes/Bayes classifier.ipynb
diff --git a/Classification Comparison/README.md → classification-comparison/README.md b/Classification Comparison/README.md → classification-comparison/README.md
diff --git a/Classification Comparison/SVM/SVM.ipynb → classification-comparison/SVM/SVM.ipynb b/Classification Comparison/SVM/SVM.ipynb → classification-comparison/SVM/SVM.ipynb
diff --git a/Classification Comparison/XGB/xgb-bow.ipynb → classification-comparison/XGB/xgb-bow.ipynb b/Classification Comparison/XGB/xgb-bow.ipynb → classification-comparison/XGB/xgb-bow.ipynb
diff --git a/...tion Comparison/XGB/xgb-tfidf-svd50.ipynb → ...tion-comparison/XGB/xgb-tfidf-svd50.ipynb b/...tion Comparison/XGB/xgb-tfidf-svd50.ipynb → ...tion-comparison/XGB/xgb-tfidf-svd50.ipynb
diff --git a/...sification Comparison/XGB/xgb-tfidf.ipynb → ...sification-comparison/XGB/xgb-tfidf.ipynb b/...sification Comparison/XGB/xgb-tfidf.ipynb → ...sification-comparison/XGB/xgb-tfidf.ipynb
diff --git a/...on Comparison/XGB/xgb-timestamp-avg.ipynb → ...on-comparison/XGB/xgb-timestamp-avg.ipynb b/...on Comparison/XGB/xgb-timestamp-avg.ipynb → ...on-comparison/XGB/xgb-timestamp-avg.ipynb
diff --git a/...tion Comparison/XGB/xgb-timestamp50.ipynb → ...tion-comparison/XGB/xgb-timestamp50.ipynb b/...tion Comparison/XGB/xgb-timestamp50.ipynb → ...tion-comparison/XGB/xgb-timestamp50.ipynb
diff --git a/...mparison/preparation/dictionary_emotion.p → ...mparison/preparation/dictionary_emotion.p b/...mparison/preparation/dictionary_emotion.p → ...mparison/preparation/dictionary_emotion.p
diff --git a/...parison/preparation/prepare-dataset.ipynb → ...parison/preparation/prepare-dataset.ipynb b/...parison/preparation/prepare-dataset.ipynb → ...parison/preparation/prepare-dataset.ipynb
diff --git a/...omparison/preparation/prepare-vocab.ipynb → ...omparison/preparation/prepare-vocab.ipynb b/...omparison/preparation/prepare-vocab.ipynb → ...omparison/preparation/prepare-vocab.ipynb
diff --git a/... Comparison/preparation/word-vector.ipynb → ...-comparison/preparation/word-vector.ipynb b/... Comparison/preparation/word-vector.ipynb → ...-comparison/preparation/word-vector.ipynb
diff --git a/dependency-parser/README.md b/dependency-parser/README.md
@@ -1,3 +1,7 @@
 ## How-to
 
+1. Run any notebook using Jupyter Notebook.
+
+## Notes
+
 For 5.attention-is-all-you-need.ipynb, you can get the dataset from https://github.com/huseinzol05/Malaya-Dataset/tree/master/dependency
diff --git a/embedded/README.md b/embedded/README.md
@@ -2,4 +2,4 @@
 
 1. Make sure `data` folder in the same directory of the notebooks.
 
-2. Run any notebooks.
+2. Run any notebook using Jupyter Notebook.
diff --git a/entity-tagging/README.md b/entity-tagging/README.md
@@ -2,4 +2,4 @@
 
 Data provided inside this directory, [entities-data-v3.json](entities-data-v3.json)
 
-1. Run any notebooks.
+1. Run any notebook using Jupyter Notebook.
diff --git a/extractive-summarization/README.md b/extractive-summarization/README.md
@@ -1,3 +1,3 @@
 ## How-to
 
-1. Just run any notebook!
+1. Run any notebook using Jupyter Notebook.
diff --git a/generator/README.md b/generator/README.md
@@ -0,0 +1,3 @@
+## How-to
+
+1. Run any notebook using Jupyter Notebook.
diff --git a/language-detection/README.md b/language-detection/README.md
@@ -12,4 +12,4 @@ tar xvf sentences.tar
 awk -F"\t" '{print"__label__"$2" "$3}' < sentences.csv | shuf > all.txt
 ```
 
-3. Run any notebooks.
+3. Run any notebook using Jupyter Notebook.
diff --git a/neural-machine-translation/README.md b/neural-machine-translation/README.md
@@ -1,6 +1,6 @@
 ## How-to
 
-1. Run any notebooks.
+1. Run any notebook using Jupyter Notebook.
 
 ## Accuracy, not sorted
 

diff --git a/ocr/README.md b/ocr/README.md
@@ -1,4 +1,4 @@
 ## How-to
 
 1. Download dataset from here, http://baidudeeplearning.bj.bcebos.com/image_contest_level_1.tar.gz
-2. Run any notebooks
+2. Run any notebook using Jupyter Notebook.
diff --git a/pos-tagging/README.md b/pos-tagging/README.md
@@ -2,4 +2,4 @@
 
 Data provided inside this directory, [pos-data-v3.json](pos-data-v3.json)
 
-1. Run any notebooks.
+1. Run any notebook using Jupyter Notebook.
diff --git a/question-answer/README.md b/question-answer/README.md
@@ -0,0 +1,3 @@
+## How-to
+
+1. Run any notebook using Jupyter Notebook.
diff --git a/speech-to-text/README.md b/speech-to-text/README.md
@@ -2,6 +2,8 @@
 
 1. First, you need to run [download.ipynb](download.ipynb)
 
-2. Run any notebooks or `train.py`.
+2. Run any notebook using Jupyter Notebook or `python train.py`.
+
+## Notes
 
 I can't train any convolution based model inside jupyter notebook due to some cuDNN issues related to jupyter.
diff --git a/stemming/README.md b/stemming/README.md
@@ -0,0 +1,3 @@
+## How-to
+
+1. Run any notebook using Jupyter Notebook.
diff --git a/text-classification/README.md b/text-classification/README.md
@@ -2,7 +2,7 @@
 
 1. Make sure `data` folder in the same directory of the notebooks.
 
-2. Run any notebooks.
+2. Run any notebook using Jupyter Notebook.
 
 ## Score and average time taken per epoch, not sorted
 

diff --git a/text-similarity/README.md b/text-similarity/README.md
@@ -6,7 +6,7 @@
 
 3. Unzip in the same notebooks location.
 
-4. Run any of it.
+4. Run any notebook using Jupyter Notebook.
 
 ## Improvement
 

diff --git a/text-to-speech/README.md b/text-to-speech/README.md
@@ -4,4 +4,4 @@
 
 2. Go to any training folder, and run [caching.py](caching.py)
 
-3. Run any training notebooks.
+3. Run any notebook using Jupyter Notebook.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,4 @@

		1. Make sure `data` folder in the same directory of the notebooks.

		2. Run any notebooks.
		2. Run any notebook using Jupyter Notebook.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,4 @@

		Data provided inside this directory, [entities-data-v3.json](entities-data-v3.json)

		1. Run any notebooks.
		1. Run any notebook using Jupyter Notebook.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		## How-to

		1. Run any notebook using Jupyter Notebook.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,4 @@

		Data provided inside this directory, [pos-data-v3.json](pos-data-v3.json)

		1. Run any notebooks.
		1. Run any notebook using Jupyter Notebook.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,4 +4,4 @@

		2. Go to any training folder, and run [caching.py](caching.py)

		3. Run any training notebooks.
		3. Run any notebook using Jupyter Notebook.