Skip to content

Commit 461607f

Browse files
authored
Merge pull request #483 from ShanleiMu/master
FEA: update readme and setuptools
2 parents b379bba + 9c1f9d6 commit 461607f

File tree

3 files changed

+18
-13
lines changed

3 files changed

+18
-13
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
# RecBole (伯乐)
66

7+
[![PyPi Latest Release](https://img.shields.io/pypi/v/recbole)](https://pypi.org/project/recbole/)
8+
[![Conda Latest Release](https://anaconda.org/aibox/recbole/badges/version.svg)](https://anaconda.org/aibox/recbole)
79
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)
810

911

@@ -36,16 +38,16 @@ by our team.
3638

3739

3840
## Feature
39-
+ *General and extensible data structure.* We design general and extensible data structures to unify the formatting and
41+
+ **General and extensible data structure.** We design general and extensible data structures to unify the formatting and
4042
usage of various recommendation datasets.
4143

42-
+ *Comprehensive benchmark models and datasets.* We implement 53 commonly used recommendation algorithms, and provide
44+
+ **Comprehensive benchmark models and datasets.** We implement 53 commonly used recommendation algorithms, and provide
4345
the formatted copies of 27 recommendation datasets.
4446

45-
+ *Efficient GPU-accelerated execution.* We optimize the efficiency of our library with a number of improved techniques
47+
+ **Efficient GPU-accelerated execution.** We optimize the efficiency of our library with a number of improved techniques
4648
oriented to the GPU environment.
4749

48-
+ *Extensive and standard evaluation protocols.* We support a series of widely adopted evaluation protocols or settings
50+
+ **Extensive and standard evaluation protocols.** We support a series of widely adopted evaluation protocols or settings
4951
for testing and comparing recommendation algorithms.
5052

5153
## RecBole News
@@ -68,7 +70,7 @@ This requires NVIDIA driver version >= 396.26 (for Linux) or >= 397.44 (for Wind
6870
### Install from conda
6971

7072
```bash
71-
conda install recbole
73+
conda install -c aibox recbole
7274
```
7375

7476
### Install from pip
@@ -161,7 +163,7 @@ Please let us know if you encounter a bug or have any suggestions by [filing an
161163

162164
We welcome all contributions from bug fixes to new features and extensions.
163165

164-
We expect all contributions discussed in the issue tracker and going through PRs
166+
We expect all contributions discussed in the issue tracker and going through PRs.
165167

166168

167169
## Cite
@@ -170,7 +172,7 @@ If you find RecBole useful for your research or development, please cite the fol
170172
```
171173
@article{recbole,
172174
title={RecBole: Towards a Unified, Comprehensive and Efficient Framework for Recommendation Algorithms},
173-
author={Wayne Xin Zhao and Shanlei Mu and Yupeng Hou and Zihan Lin and Kaiyuan Li and Yushuo Chen and Yujie Lu and Hui Wang and Changxin Tian and Yingqian Min and Zhichao Feng and Xingyu Pan and Xinyan Fan and Xu Chen and Pengfei Wang and Wendi Ji and Yaliang Li and Zhen Wang and Xiaoling Wang and Ji-Rong Wen},
175+
author={Wayne Xin Zhao and Shanlei Mu and Yupeng Hou and Zihan Lin and Kaiyuan Li and Yushuo Chen and Yujie Lu and Hui Wang and Changxin Tian and Yingqian Min and Zhichao Feng and Xingyu Pan and Xinyan Fan and Xu Chen and Pengfei Wang and Wendi Ji and Yaliang Li and Xiaoling Wang and Ji-Rong Wen},
174176
year={2020},
175177
journal={arXiv preprint arXiv:}
176178
}
@@ -180,4 +182,4 @@ If you find RecBole useful for your research or development, please cite the fol
180182
RecBole is developed and maintained by [RUC, BUPT, ECNU](https://www.recbole.io/about.html).
181183

182184
## License
183-
RecBole uses MIT License.
185+
RecBole uses [MIT License](./LICENSE).

recbole/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
from __future__ import print_function
33
from __future__ import division
44

5-
__version__ = '0.1.0'
5+
__version__ = '0.1.1'

setup.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,13 @@
77
from setuptools import setup, find_packages
88

99
install_requires = ['numpy>=1.17.2', 'torch>=1.6.0', 'scipy>=1.3.1', 'pandas>=1.0.5', 'tqdm>=4.48.2',
10-
'scikit_learn>=0.23.2', 'pyyaml>=5.1.0', 'matplotlib>=3.1.3', 'hyperopt>=0.2.4']
10+
'scikit_learn>=0.23.2', 'pyyaml>=5.1.0', 'matplotlib>=3.1.3']
1111

1212
setup_requires = []
1313

14-
extras_require = {}
14+
extras_require = {
15+
'hyperopt': ['hyperopt>=0.2.4']
16+
}
1517

1618
classifiers = ["License :: OSI Approved :: MIT License"]
1719

@@ -22,7 +24,8 @@
2224
'includes 53 recommendation algorithms, covering four ' \
2325
'major categories: General Recommendation, Sequential ' \
2426
'Recommendation, Context-aware Recommendation and ' \
25-
'Knowledge-based Recommendation.'
27+
'Knowledge-based Recommendation. View RecBole homepage ' \
28+
'for more information: https://recbole.io'
2629

2730
# Readthedocs requires Sphinx extensions to be specified as part of
2831
# install_requires in order to build properly.
@@ -33,7 +36,7 @@
3336
setup(
3437
name='recbole',
3538
version=
36-
'0.1.0', # please remember to edit recbole/__init__.py in response, once updating the version
39+
'0.1.1', # please remember to edit recbole/__init__.py in response, once updating the version
3740
description='A unified, comprehensive and efficient recommendation library',
3841
long_description=long_description,
3942
long_description_content_type="text/markdown",

0 commit comments

Comments
 (0)