Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation typo #1359

Merged
merged 5 commits into from
Jul 23, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Introduction
RecBole is a unified, comprehensive and efficient framework developed based on PyTorch.
It aims to help the researchers to reproduce and develop recommendation models.

In the lastest release, our library includes 77 recommendation algorithms `[Model List]`_, covering four major categories:
In the lastest release, our library includes 81 recommendation algorithms `[Model List]`_, covering four major categories:

- General Recommendation
- Sequential Recommendation
Expand All @@ -29,7 +29,7 @@ Features:
- General and extensible data structure
We deign general and extensible data structures to unify the formatting and usage of various recommendation datasets.
- Comprehensive benchmark models and datasets
We implement 77 commonly used recommendation algorithms, and provide the formatted copies of 28 recommendation datasets.
We implement 81 commonly used recommendation algorithms, and provide the formatted copies of 28 recommendation datasets.
- Efficient GPU-accelerated execution
We design many tailored strategies in the GPU environment to enhance the efficiency of our library.
- Extensive and standard evaluation protocols
Expand Down
2 changes: 1 addition & 1 deletion docs/source/user_guide/model_intro.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Model Introduction
=====================
We implement 77 recommendation models covering general recommendation, sequential recommendation,
We implement 81 recommendation models covering general recommendation, sequential recommendation,
context-aware recommendation and knowledge-based recommendation. A brief introduction to these models are as follows:


Expand Down
4 changes: 2 additions & 2 deletions recbole/model/exlib_recommender/__init__.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
from recbole.model.exlib_recommender.lightgbm import lightgbm
from recbole.model.exlib_recommender.xgboost import xgboost
from recbole.model.exlib_recommender.lightgbm import LightGBM
from recbole.model.exlib_recommender.xgboost import XGBoost
4 changes: 2 additions & 2 deletions recbole/model/exlib_recommender/lightgbm.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
from recbole.utils import ModelType, InputType


class lightgbm(lgb.Booster):
r"""lightgbm is inherited from lgb.Booster"""
class LightGBM(lgb.Booster):
r"""LightGBM is inherited from lgb.Booster"""
type = ModelType.DECISIONTREE
input_type = InputType.POINTWISE

Expand Down
4 changes: 2 additions & 2 deletions recbole/model/exlib_recommender/xgboost.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
from recbole.utils import ModelType, InputType


class xgboost(xgb.Booster):
r"""xgboost is inherited from xgb.Booster"""
class XGBoost(xgb.Booster):
r"""XGBoost is inherited from xgb.Booster"""
type = ModelType.DECISIONTREE
input_type = InputType.POINTWISE

Expand Down
2 changes: 1 addition & 1 deletion recbole/model/general_recommender/nceplrec.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
NCE-PLRec
######################################
Reference:
Ga Wu, et al. "Noise Contrastive Estimation for One-Class Collaborative Filtering" in Sigir 2019.
Ga Wu, et al. "Noise Contrastive Estimation for One-Class Collaborative Filtering" in SIGIR 2019.
Reference code:
https://github.com/wuga214/NCE_Projected_LRec
"""
Expand Down
2 changes: 1 addition & 1 deletion recbole/model/sequential_recommender/npe.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
################################################

Reference:
ThaiBinh Nguyen, et al. "NPE: Neural Personalized Embedding for Collaborative Filtering" in ijcai2018
ThaiBinh Nguyen, et al. "NPE: Neural Personalized Embedding for Collaborative Filtering" in IJCAI 2018.

Reference code:
https://github.com/wubinzzu/NeuRec
Expand Down
12 changes: 6 additions & 6 deletions recbole/trainer/trainer.py
Original file line number Diff line number Diff line change
Expand Up @@ -1065,11 +1065,11 @@ def _train_at_once(self, train_data, valid_data):
raise NotImplementedError


class xgboostTrainer(DecisionTreeTrainer):
"""xgboostTrainer is designed for XGBOOST."""
class XGBoostTrainer(DecisionTreeTrainer):
"""XGBoostTrainer is designed for XGBOOST."""

def __init__(self, config, model):
super(xgboostTrainer, self).__init__(config, model)
super(XGBoostTrainer, self).__init__(config, model)

self.xgb = __import__("xgboost")
self.boost_model = config["xgb_model"]
Expand Down Expand Up @@ -1144,11 +1144,11 @@ def evaluate(
return result


class lightgbmTrainer(DecisionTreeTrainer):
"""lightgbmTrainer is designed for lightgbm."""
class LightGBMTrainer(DecisionTreeTrainer):
"""LightGBMTrainer is designed for LightGBM."""

def __init__(self, config, model):
super(lightgbmTrainer, self).__init__(config, model)
super(LightGBMTrainer, self).__init__(config, model)

self.lgb = __import__("lightgbm")
self.boost_model = config["lgb_model"]
Expand Down
4 changes: 2 additions & 2 deletions tests/model/test_model_auto.py
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ def test_dcn(self):

def test_xgboost(self):
config_dict = {
"model": "xgboost",
"model": "XGBoost",
"threshold": {"rating": 4},
"xgb_params": {
"booster": "gbtree",
Expand All @@ -375,7 +375,7 @@ def test_xgboost(self):

def test_lightgbm(self):
config_dict = {
"model": "lightgbm",
"model": "LightGBM",
"threshold": {"rating": 4},
"lgb_params": {
"boosting": "gbdt",
Expand Down