readme edited

README.md

@@ -1,2 +1,52 @@
-# pytorch-tutorial
+<p align="center"><img width="40%" src="png/pytorch_logo.png" /></p>
-tutorial for deep learning researcher to learn pytorch.
+
+--------------------------------------------------------------------------------
+
+This repository provides tutorial code for deep learning researchers to learn [PyTorch](https://github.com/pytorch/pytorch). In the tutorial, most of the models were implemented with less than 30 lines of code. Before starting this tutorial, it is recommended to finish [Official Pytorch Tutorial](https://github.com/pytorch/tutorials/blob/master/Deep%20Learning%20with%20PyTorch.ipynb).
+
+
+<br/>
+
+## Table of Contents
+
+* [PyTorch Basics](https://github.com/yunjey/pytorch-tutorial/blob/master/00%20-%20PyTorch%20Basics/main.py)
+* [Linear Regression](https://github.com/yunjey/pytorch-tutorial/blob/master/04%20-%20Linear%20Regression/main.py)
+* [Logistic Regression](https://github.com/yunjey/pytorch-tutorial/blob/master/05%20-%20Logistic%20Regression/main.py)
+* [Feedforward Neural Network](https://github.com/yunjey/pytorch-tutorial/blob/master/01%20-%20Feedforward%20Neural%20Network/main.py)
+* [Convolutional Neural Network](https://github.com/yunjey/pytorch-tutorial/blob/master/02%20-%20Convolutional%20Neural%20Network/main.py)
+* [Deep Residual Network](https://github.com/yunjey/pytorch-tutorial/blob/master/03%20-%20Deep%20Residual%20Network/main-gpu.py)
+* [Recurrent Neural Network](https://github.com/yunjey/pytorch-tutorial/blob/master/06%20-%20Recurrent%20Neural%20Network/main.py)
+* [Bidirectional Recurrent Neural Network](https://github.com/yunjey/pytorch-tutorial/blob/master/07%20-%20Bidirectional%20Recurrent%20Neural%20Network/main.py)
+* [Language Model (RNNLM)](https://github.com/yunjey/pytorch-tutorial/blob/master/09%20-%20Language%20Model/main-gpu.py)
+* Image Captioning (CNN-RNN)
+* [Generative Adversarial Network](https://github.com/yunjey/pytorch-tutorial/blob/master/08%20-%20Generative%20Adversarial%20Network/main.py)
+* [Deep Q-Network and Q-learning (WIP)](https://github.com/yunjey/pytorch-tutorial/blob/master/10%20-%20Deep%20Q%20Network/dqn13.py)
+
+
+<br/>
+
+## Getting Started
+```bash
+$ git clone https://github.com/yunjey/pytorch-tutorial.git
+$ cd pytorch-tutorial/project/
+$ python main.py               # cpu version
+$ python main-gpu.py           # gpu version
+```
+
+<br/>
+
+## Dependencies
+* [pytorch](https://github.com/pytorch/pytorch)
+* [pytorch-vision](https://github.com/pytorch/vision)
+* [gym](https://github.com/openai/gym)   
+
+
+<br/>
+
+## Future Work
+* [One-shot Learning](https://arxiv.org/abs/1606.04080)
+* [Question Answering](https://rajpurkar.github.io/SQuAD-explorer/)
+* [Visual Question Answering](http://www.visualqa.org/)
+
+
+<br/>