Skip to content

Commit

Permalink
Merge pull request #483 from ShanleiMu/master
Browse files Browse the repository at this point in the history
FEA: update readme and setuptools
  • Loading branch information
ShanleiMu authored Nov 3, 2020
2 parents b379bba + 9c1f9d6 commit 461607f
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 13 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

# RecBole (伯乐)

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


Expand Down Expand Up @@ -36,16 +38,16 @@ by our team.


## Feature
+ *General and extensible data structure.* We design general and extensible data structures to unify the formatting and
+ **General and extensible data structure.** We design general and extensible data structures to unify the formatting and
usage of various recommendation datasets.

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

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

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

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

```bash
conda install recbole
conda install -c aibox recbole
```

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

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

We expect all contributions discussed in the issue tracker and going through PRs
We expect all contributions discussed in the issue tracker and going through PRs.


## Cite
Expand All @@ -170,7 +172,7 @@ If you find RecBole useful for your research or development, please cite the fol
```
@article{recbole,
title={RecBole: Towards a Unified, Comprehensive and Efficient Framework for Recommendation Algorithms},
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},
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},
year={2020},
journal={arXiv preprint arXiv:}
}
Expand All @@ -180,4 +182,4 @@ If you find RecBole useful for your research or development, please cite the fol
RecBole is developed and maintained by [RUC, BUPT, ECNU](https://www.recbole.io/about.html).

## License
RecBole uses MIT License.
RecBole uses [MIT License](./LICENSE).
2 changes: 1 addition & 1 deletion recbole/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
from __future__ import print_function
from __future__ import division

__version__ = '0.1.0'
__version__ = '0.1.1'
11 changes: 7 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@
from setuptools import setup, find_packages

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

setup_requires = []

extras_require = {}
extras_require = {
'hyperopt': ['hyperopt>=0.2.4']
}

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

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

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

0 comments on commit 461607f

Please sign in to comment.