Skip to content

Commit

Permalink
Update README (#237)
Browse files Browse the repository at this point in the history
  • Loading branch information
gpengzhi committed Oct 15, 2019
1 parent 66488b9 commit bd4c514
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Texar-PyTorch integrates many of the best features of TensorFlow into PyTorch, d

### Library API Example
A code example that builds and trains a **Conditional GPT2** model (e.g., for machine translation and text summarization):

```python
import texar.torch as tx
from texar.torch.run import *
Expand Down Expand Up @@ -107,9 +108,9 @@ Many more examples are available [here](./examples).


### Installation
Texar-PyTorch requires `PyTorch>=1.0`. Please follow the [official instructions](https://pytorch.org/get-started/locally/#start-locally) to install the appropriate version.
Texar-PyTorch requires `torch >= 1.0.0 (but < 1.3.0)`. Please follow the [official instructions](https://pytorch.org/get-started/locally/#start-locally) to install the appropriate version.

After PyTorch is installed, please run the following commands to install Texar-PyTorch:
After `torch` is installed, please run the following commands to install Texar-PyTorch:
```
git clone https://github.com/asyml/texar-pytorch.git
cd texar-pytorch
Expand All @@ -129,6 +130,7 @@ pip install tensorboardX

### Reference
If you use Texar, please cite the [tech report](https://arxiv.org/abs/1809.00794) with the following BibTex entry:

```
Texar: A Modularized, Versatile, and Extensible Toolkit for Text Generation
Zhiting Hu, Haoran Shi, Bowen Tan, Wentao Wang, Zichao Yang, Tiancheng Zhao, Junxian He, Lianhui Qin, Di Wang, Xuezhe Ma, Zhengzhong Liu, Xiaodan Liang, Wanrong Zhu, Devendra Sachan and Eric Xing
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
torch >= 1.0.0
torch >= 1.0.0, < 1.3.0
funcsigs >= 1.0.2
numpy >= 1.15.4
mypy_extensions >= 0.4.1
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
'packaging>=19.0'
],
extras_require={
'torch': ['torch>=1.0'],
'torch': ['torch>=1.0.0,<1.3.0'],
'examples': [],
'extras': ['Pillow>=3.0', 'tensorboardX>=1.8'],
},
Expand Down

0 comments on commit bd4c514

Please sign in to comment.