Skip to content

Commit 821c7db

Browse files
committed
Minor update of README and setup.py
1 parent b4ac155 commit 821c7db

File tree

2 files changed

+23
-10
lines changed

2 files changed

+23
-10
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,10 @@
88
[![Documentation Status](https://readthedocs.org/projects/texar/badge/?version=latest)](https://texar.readthedocs.io/en/latest/?badge=latest)
99
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/asyml/texar/blob/master/LICENSE)
1010

11-
**Texar** is an open-source toolkit based on TensorFlow, aiming to support a broad set of machine learning especially **text generation tasks**, such as machine translation, dialog, summarization, content manipulation, language modeling, and so on. Texar is designed for both researchers and practitioners for fast prototyping and experimentation.
11+
**Texar** is an open-source toolkit based on TensorFlow, aiming to support a broad set of machine learning, especially text generation tasks, such as machine translation, dialog, summarization, content manipulation, language modeling, and so on. Texar is designed for both researchers and practitioners for fast prototyping and experimentation.
1212

13+
*If you work with PyTorch, be sure to check out **[Texar-PyTorch](https://github.com/asyml/texar-pytorch)** which has (mostly) the **same functionalities and interfaces**.*
14+
1315
With the design goals of **modularity, versatility, and extensibility** in mind, Texar extracts the common patterns underlying the diverse tasks and methodologies, creates a library of highly reusable modules and functionalities, and facilitates **arbitrary model architectures and algorithmic paradigms**, e.g.,
1416
* encoder(s) to decoder(s), sequential- and self-attentions, memory, hierarchical models, classifiers...
1517
* maximum likelihood learning, reinforcement learning, adversarial learning, probabilistic modeling, ...
@@ -27,6 +29,7 @@ Users can construct their own models at a high conceptual level just like assemb
2729
* **Extensibility**. It is straightforward to integrate any user-customized, external modules. Also, Texar is fully compatible with the native TensorFlow interfaces and can take advantage of the rich TensorFlow features, and resources from the vibrant open-source community.
2830
* Interfaces with different functionality levels. Users can customize a model through 1) simple **Python/YAML configuration files** of provided model templates/examples; 2) programming with **Python Library APIs** for maximal customizability.
2931
* Easy-to-use APIs: 1) Convenient automatic variable re-use---no worry about the complicated TF variable scopes; 2) PyTorch-like callable modules; 3) Rich configuration options for each module, all with default values; ...
32+
* **Pretrained Models** such as **BERT**, **GPT2**, and more!
3033
* Well-structured high-quality code of uniform design patterns and consistent styles.
3134
* Clean, detailed [documentation](https://texar.readthedocs.io) and rich [examples](./examples).
3235
* **Distributed model training** with multiple GPUs.
@@ -87,15 +90,15 @@ pip install -e .
8790
* [Documentation](https://texar.readthedocs.io)
8891

8992
### Reference
90-
If you use Texar, please cite the [report](https://arxiv.org/abs/1809.00794) with the following BibTex entry:
93+
If you use Texar, please cite the [tech report](https://arxiv.org/abs/1809.00794) with the following BibTex entry:
9194
```
9295
Texar: A Modularized, Versatile, and Extensible Toolkit for Text Generation
93-
Zhiting Hu, Haoran Shi, Zichao Yang, Bowen Tan, Tiancheng Zhao, Junxian He, Wentao Wang, Lianhui Qin, Di Wang, Xuezhe Ma, Hector Liu, Xiaodan Liang, Wanrong Zhu, Devendra Singh Sachan, Eric P. Xing
96+
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
9497
2018
9598
9699
@article{hu2018texar,
97100
title={Texar: A Modularized, Versatile, and Extensible Toolkit for Text Generation},
98-
author={Hu, Zhiting and Shi, Haoran and Yang, Zichao and Tan, Bowen and Zhao, Tiancheng and He, Junxian and Wang, Wentao and Qin, Lianhui and Wang, Di and others},
101+
author={Hu, Zhiting and Shi, Haoran and Tan, Bowen and Wang, Wentao and Yang, Zichao and Zhao, Tiancheng and He, Junxian and Qin, Lianhui and Wang, Di and others},
99102
journal={arXiv preprint arXiv:1809.00794},
100103
year={2018}
101104
}

setup.py

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,22 @@
33

44
long_description = '''
55
Texar is an open-source toolkit based on Tensorflow,
6-
aiming to support a broad set of machine learning especially text generation tasks,
7-
such as machine translation, dialog, summarization, content manipulation, language modeling, and so on.
6+
aiming to support a broad set of machine learning especially text generation
7+
tasks, such as machine translation, dialog, summarization, content manipulation,
8+
language modeling, and so on.
89
9-
Texar is designed for both researchers and practitioners for fast prototyping and experimentation.
10+
Texar is designed for both researchers and practitioners for fast prototyping
11+
and experimentation. Checkout https://github.com/asyml/texar-pytorch for the
12+
PyTorch version which has the same functionalities and (mostly) the same
13+
interfaces.
1014
'''
1115

1216
setuptools.setup(
1317
name="texar",
1418
version="0.2.1",
1519
url="https://github.com/asyml/texar",
1620

17-
description="Toolkit for Text Generation and Beyond",
21+
description="Toolkit for Machine Learning and Text Generation",
1822
long_description=long_description,
1923
license='Apache License Version 2.0',
2024

@@ -28,8 +32,14 @@
2832
'funcsigs',
2933
],
3034
extras_require={
31-
'tensorflow-cpu': ['tensorflow>=1.7.0', 'tensorflow-probability >= 0.3.0'],
32-
'tensorflow-gpu': ['tensorflow-gpu>=1.7.0', 'tensorflow-probability-gpu >= 0.3.0']
35+
'tensorflow-cpu': [
36+
'tensorflow>=1.7.0',
37+
'tensorflow-probability >= 0.3.0'
38+
],
39+
'tensorflow-gpu': [
40+
'tensorflow-gpu>=1.7.0',
41+
'tensorflow-probability-gpu >= 0.3.0'
42+
]
3343
},
3444
package_data={
3545
"texar": [

0 commit comments

Comments
 (0)