torch-rechub 0.0.1__tar.gz → 0.0.3__tar.gz

{torch-rechub-0.0.1 → torch_rechub-0.0.3}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 Mincai Lai
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 Datawhale
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

torch_rechub-0.0.3/PKG-INFO

@@ -0,0 +1,177 @@
+Metadata-Version: 2.1
+Name: torch-rechub
+Version: 0.0.3
+Summary: A Lighting Pytorch Framework for Recommendation System, Easy-to-use and Easy-to-extend.
+Home-page: https://github.com/datawhalechina/torch-rechub
+Author: Datawhale
+Author-email: laimc@shanghaitech.edu.cn
+Keywords: ctr,click through rate,deep learning,pytorch,recsys,recommendation
+Platform: all
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.19.0
+Requires-Dist: torch>=1.7.0
+Requires-Dist: pandas>=1.0.5
+Requires-Dist: tqdm>=4.64.0
+Requires-Dist: scikit_learn>=0.23.2
+Requires-Dist: annoy>=1.17.0
+
+# Torch-RecHub
+
+<p align="left">
+  <img src='https://img.shields.io/badge/python-3.8+-brightgreen'>
+  <img src='https://img.shields.io/badge/torch-1.7+-brightgreen'>
+  <img src='https://img.shields.io/badge/scikit_learn-0.23.2+-brightgreen'>
+  <img src='https://img.shields.io/badge/pandas-1.0.5+-brightgreen'>
+  <img src='https://img.shields.io/badge/annoy-1.17.0-brightgreen'>
+  <img src="https://img.shields.io/pypi/l/torch-rechub">
+ <a href="https://github.com/datawhalechina/torch-rechub"><img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fdatawhalechina%2Ftorch-rechub&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false"/></a>
+
+## 中文Wiki站
+
+查看最新研发进度，认领感兴趣的研发任务，学习rechub模型复现心得，加入rechub共建者团队等
+
+[点击链接](https://www.wolai.com/rechub/2qjdg3DPy1179e1vpcHZQC)
+
+## 安装
+
+```python
+#稳定版 
+pip install torch-rechub
+
+#最新版（推荐）
+1. git clone https://github.com/datawhalechina/torch-rechub.git
+2. cd torch-rechub
+3. python setup.py install
+```
+
+## 核心定位
+
+易用易拓展，聚焦复现业界实用的推荐模型，以及泛生态化的推荐场景
+
+## 主要特性
+
+*   scikit-learn风格易用的API（fit、predict），即插即用
+
+*   模型训练与模型定义解耦，易拓展，可针对不同类型的模型设置不同的训练机制
+
+*   接受pandas的DataFrame、Dict数据输入，上手成本低
+
+*   高度模块化，支持常见Layer，容易调用组装成新模型
+
+    *   LR、MLP、FM、FFM、CIN
+
+    *   target-attention、self-attention、transformer
+
+*   支持常见排序模型
+
+    *   WideDeep、DeepFM、DIN、DCN、xDeepFM等
+
+*   支持常见召回模型
+
+    *   DSSM、YoutubeDNN、YoutubeDSSM、FacebookEBR、MIND等
+
+*   丰富的多任务学习支持
+
+    *   SharedBottom、ESMM、MMOE、PLE、AITM等模型
+
+    *   GradNorm、UWL、MetaBanlance等动态loss加权机制
+
+*   聚焦更生态化的推荐场景
+
+    - [ ] 冷启动
+
+    - [ ] 延迟反馈
+
+    *   [ ] 去偏
+
+*   支持丰富的训练机制
+
+    *   [ ] 对比学习
+
+    *   [ ] 蒸馏学习
+
+*   [ ] 第三方高性能开源Trainer支持（Pytorch Lighting）
+
+*   [ ] 更多模型正在开发中
+
+## 快速使用
+
+### 使用案例
+
+- 所有模型使用案例参考 `/examples`
+
+- 202206 Datawhale-RecHub推荐课程 组队学习期间notebook教程参考 `/tutorials`
+
+### 精排（CTR预测）
+
+```python
+from torch_rechub.models.ranking import DeepFM
+from torch_rechub.trainers import CTRTrainer
+from torch_rechub.utils.data import DataGenerator
+
+dg = DataGenerator(x, y)
+train_dataloader, val_dataloader, test_dataloader = dg.generate_dataloader(split_ratio=[0.7, 0.1], batch_size=256)
+
+model = DeepFM(deep_features=deep_features, fm_features=fm_features, mlp_params={"dims": [256, 128], "dropout": 0.2, "activation": "relu"})
+
+ctr_trainer = CTRTrainer(model)
+ctr_trainer.fit(train_dataloader, val_dataloader)
+auc = ctr_trainer.evaluate(ctr_trainer.model, test_dataloader)
+```
+
+### 多任务排序
+
+```python
+from torch_rechub.models.multi_task import SharedBottom, ESMM, MMOE, PLE, AITM
+from torch_rechub.trainers import MTLTrainer
+
+task_types = ["classification", "classification"] 
+model = MMOE(features, task_types, 8, expert_params={"dims": [32,16]}, tower_params_list=[{"dims": [32, 16]}, {"dims": [32, 16]}])
+
+mtl_trainer = MTLTrainer(model)
+mtl_trainer.fit(train_dataloader, val_dataloader)
+auc = ctr_trainer.evaluate(ctr_trainer.model, test_dataloader)
+```
+
+### 召回模型
+
+```python
+from torch_rechub.models.matching import DSSM
+from torch_rechub.trainers import MatchTrainer
+from torch_rechub.utils.data import MatchDataGenerator
+
+dg = MatchDataGenerator(x y)
+train_dl, test_dl, item_dl = dg.generate_dataloader(test_user, all_item, batch_size=256)
+
+model = DSSM(user_features, item_features, temperature=0.02,
+             user_params={
+                 "dims": [256, 128, 64],
+                 "activation": 'prelu',  
+             },
+             item_params={
+                 "dims": [256, 128, 64],
+                 "activation": 'prelu', 
+             })
+
+match_trainer = MatchTrainer(model)
+match_trainer.fit(train_dl)
+
+```
+

torch_rechub-0.0.3/README.md

@@ -0,0 +1,143 @@
+# Torch-RecHub
+
+<p align="left">
+  <img src='https://img.shields.io/badge/python-3.8+-brightgreen'>
+  <img src='https://img.shields.io/badge/torch-1.7+-brightgreen'>
+  <img src='https://img.shields.io/badge/scikit_learn-0.23.2+-brightgreen'>
+  <img src='https://img.shields.io/badge/pandas-1.0.5+-brightgreen'>
+  <img src='https://img.shields.io/badge/annoy-1.17.0-brightgreen'>
+  <img src="https://img.shields.io/pypi/l/torch-rechub">
+ <a href="https://github.com/datawhalechina/torch-rechub"><img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fdatawhalechina%2Ftorch-rechub&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false"/></a>
+
+## 中文Wiki站
+
+查看最新研发进度，认领感兴趣的研发任务，学习rechub模型复现心得，加入rechub共建者团队等
+
+[点击链接](https://www.wolai.com/rechub/2qjdg3DPy1179e1vpcHZQC)
+
+## 安装
+
+```python
+#稳定版 
+pip install torch-rechub
+
+#最新版（推荐）
+1. git clone https://github.com/datawhalechina/torch-rechub.git
+2. cd torch-rechub
+3. python setup.py install
+```
+
+## 核心定位
+
+易用易拓展，聚焦复现业界实用的推荐模型，以及泛生态化的推荐场景
+
+## 主要特性
+
+*   scikit-learn风格易用的API（fit、predict），即插即用
+
+*   模型训练与模型定义解耦，易拓展，可针对不同类型的模型设置不同的训练机制
+
+*   接受pandas的DataFrame、Dict数据输入，上手成本低
+
+*   高度模块化，支持常见Layer，容易调用组装成新模型
+
+    *   LR、MLP、FM、FFM、CIN
+
+    *   target-attention、self-attention、transformer
+
+*   支持常见排序模型
+
+    *   WideDeep、DeepFM、DIN、DCN、xDeepFM等
+
+*   支持常见召回模型
+
+    *   DSSM、YoutubeDNN、YoutubeDSSM、FacebookEBR、MIND等
+
+*   丰富的多任务学习支持
+
+    *   SharedBottom、ESMM、MMOE、PLE、AITM等模型
+
+    *   GradNorm、UWL、MetaBanlance等动态loss加权机制
+
+*   聚焦更生态化的推荐场景
+
+    - [ ] 冷启动
+
+    - [ ] 延迟反馈
+
+    *   [ ] 去偏
+
+*   支持丰富的训练机制
+
+    *   [ ] 对比学习
+
+    *   [ ] 蒸馏学习
+
+*   [ ] 第三方高性能开源Trainer支持（Pytorch Lighting）
+
+*   [ ] 更多模型正在开发中
+
+## 快速使用
+
+### 使用案例
+
+- 所有模型使用案例参考 `/examples`
+
+- 202206 Datawhale-RecHub推荐课程 组队学习期间notebook教程参考 `/tutorials`
+
+### 精排（CTR预测）
+
+```python
+from torch_rechub.models.ranking import DeepFM
+from torch_rechub.trainers import CTRTrainer
+from torch_rechub.utils.data import DataGenerator
+
+dg = DataGenerator(x, y)
+train_dataloader, val_dataloader, test_dataloader = dg.generate_dataloader(split_ratio=[0.7, 0.1], batch_size=256)
+
+model = DeepFM(deep_features=deep_features, fm_features=fm_features, mlp_params={"dims": [256, 128], "dropout": 0.2, "activation": "relu"})
+
+ctr_trainer = CTRTrainer(model)
+ctr_trainer.fit(train_dataloader, val_dataloader)
+auc = ctr_trainer.evaluate(ctr_trainer.model, test_dataloader)
+```
+
+### 多任务排序
+
+```python
+from torch_rechub.models.multi_task import SharedBottom, ESMM, MMOE, PLE, AITM
+from torch_rechub.trainers import MTLTrainer
+
+task_types = ["classification", "classification"] 
+model = MMOE(features, task_types, 8, expert_params={"dims": [32,16]}, tower_params_list=[{"dims": [32, 16]}, {"dims": [32, 16]}])
+
+mtl_trainer = MTLTrainer(model)
+mtl_trainer.fit(train_dataloader, val_dataloader)
+auc = ctr_trainer.evaluate(ctr_trainer.model, test_dataloader)
+```
+
+### 召回模型
+
+```python
+from torch_rechub.models.matching import DSSM
+from torch_rechub.trainers import MatchTrainer
+from torch_rechub.utils.data import MatchDataGenerator
+
+dg = MatchDataGenerator(x y)
+train_dl, test_dl, item_dl = dg.generate_dataloader(test_user, all_item, batch_size=256)
+
+model = DSSM(user_features, item_features, temperature=0.02,
+             user_params={
+                 "dims": [256, 128, 64],
+                 "activation": 'prelu',  
+             },
+             item_params={
+                 "dims": [256, 128, 64],
+                 "activation": 'prelu', 
+             })
+
+match_trainer = MatchTrainer(model)
+match_trainer.fit(train_dl)
+
+```
+

{torch-rechub-0.0.1 → torch_rechub-0.0.3}/setup.cfg

@@ -1,4 +1,4 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-
+[egg_info]
+tag_build = 
+tag_date = 0
+

{torch-rechub-0.0.1 → torch_rechub-0.0.3}/setup.py

@@ -1,35 +1,37 @@
-from distutils.core import setup
-from setuptools import find_packages
-
-with open("README.md", "r") as f:
-    long_description = f.read()
-
-setup(
-    name='torch-rechub',  # 包名
-    version='0.0.1',  # 版本号
-    description='A Lighting Pytorch Framework for Recommendation System, Easy-to-use and Easy-to-extend.',
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    author='Mincai lai',
-    author_email='757387961@qq.com',
-    url='https://github.com/morningsky/Torch-RecHub',
-    install_requires=['numpy>=1.21.5', 'torch>=1.7.0', 'pandas>=1.0.5', 'tqdm>=4.64.0', 'scikit_learn>=0.23.2'],
-    packages=find_packages(),
-    platforms=["all"],
-    classifiers=[
-        'Intended Audience :: Developers',
-        "Intended Audience :: Education",
-        "Intended Audience :: Science/Research",
-        'Operating System :: OS Independent',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.7',
-        'Programming Language :: Python :: 3.8',
-        'Programming Language :: Python :: 3.9',
-        'Topic :: Scientific/Engineering',
-        'Topic :: Scientific/Engineering :: Artificial Intelligence',
-        'Topic :: Software Development :: Libraries',
-        'Topic :: Software Development :: Libraries :: Python Modules',
-        'License :: OSI Approved :: MIT License',
-    ],
-    keywords=['ctr', 'click through rate', 'deep learning', 'pytorch', 'recsys', 'recommendation'],
-)
+from setuptools import setup, find_packages
+
+with open("README.md", "r", encoding='utf-8') as f:
+     long_description = f.read()
+     
+setup(
+    name='torch-rechub',
+    version='0.0.3',
+    description='A Lighting Pytorch Framework for Recommendation System, Easy-to-use and Easy-to-extend.',
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    author='Datawhale',
+    author_email='laimc@shanghaitech.edu.cn',
+    url='https://github.com/datawhalechina/torch-rechub',
+    install_requires=['numpy>=1.19.0', 'torch>=1.7.0', 'pandas>=1.0.5', 'tqdm>=4.64.0', 'scikit_learn>=0.23.2', 'annoy>=1.17.0'],
+    packages=find_packages(),
+    platforms=["all"],
+    classifiers=[
+        'Intended Audience :: Developers',
+        "Intended Audience :: Education",
+        "Intended Audience :: Science/Research",
+        'Operating System :: OS Independent',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
+        'Programming Language :: Python :: 3.12',
+        'Topic :: Scientific/Engineering',
+        'Topic :: Scientific/Engineering :: Artificial Intelligence',
+        'Topic :: Software Development :: Libraries',
+        'Topic :: Software Development :: Libraries :: Python Modules',
+        'License :: OSI Approved :: MIT License',
+    ],
+    keywords=['ctr', 'click through rate', 'deep learning', 'pytorch', 'recsys', 'recommendation'],
+    python_requires='>=3.8',
+)

{torch-rechub-0.0.1 → torch_rechub-0.0.3}/torch_rechub/basic/activation.py

@@ -1,52 +1,54 @@
-import torch
-import torch.nn as nn
-
-
-class Dice(nn.Module):
-    """The Dice activation function mentioned in the `DIN paper
-    https://arxiv.org/abs/1706.06978`
-    """
-
-    def __init__(self, epsilon=1e-3):
-        super(Dice, self).__init__()
-        self.epsilon = epsilon
-        self.alpha = nn.Parameter(torch.randn(1))
-
-    def forward(self, x: torch.Tensor):
-        # x: N * num_neurons
-        avg = x.mean(dim=1)  # N
-        avg = avg.unsqueeze(dim=1)  # N * 1
-        var = torch.pow(x - avg, 2) + self.epsilon  # N * num_neurons
-        var = var.sum(dim=1).unsqueeze(dim=1)  # N * 1
-
-        ps = (x - avg) / torch.sqrt(var)  # N * 1
-
-        ps = nn.Sigmoid()(ps)  # N * 1
-        return ps * x + (1 - ps) * self.alpha * x
-
-
-def activation_layer(act_name):
-    """Construct activation layers
-
-    Args:
-        act_name: str or nn.Module, name of activation function
-    
-    Returns:
-        act_layer: activation layer
-    """
-    if isinstance(act_name, str):
-        if act_name.lower() == 'sigmoid':
-            act_layer = nn.Sigmoid()
-        elif act_name.lower() == 'relu':
-            act_layer = nn.ReLU(inplace=True)
-        elif act_name.lower() == 'dice':
-            act_layer = Dice()
-        elif act_name.lower() == 'prelu':
-            act_layer = nn.PReLU()
-        elif act_name.lower() == "softmax":
-            act_layer = nn.Softmax(dim=1)
-    elif issubclass(act_name, nn.Module):
-        act_layer = act_name()
-    else:
-        raise NotImplementedError
-    return act_layer
+import torch
+import torch.nn as nn
+
+
+class Dice(nn.Module):
+    """The Dice activation function mentioned in the `DIN paper
+    https://arxiv.org/abs/1706.06978`
+    """
+
+    def __init__(self, epsilon=1e-3):
+        super(Dice, self).__init__()
+        self.epsilon = epsilon
+        self.alpha = nn.Parameter(torch.randn(1))
+
+    def forward(self, x: torch.Tensor):
+        # x: N * num_neurons
+        avg = x.mean(dim=1)  # N
+        avg = avg.unsqueeze(dim=1)  # N * 1
+        var = torch.pow(x - avg, 2) + self.epsilon  # N * num_neurons
+        var = var.sum(dim=1).unsqueeze(dim=1)  # N * 1
+
+        ps = (x - avg) / torch.sqrt(var)  # N * 1
+
+        ps = nn.Sigmoid()(ps)  # N * 1
+        return ps * x + (1 - ps) * self.alpha * x
+
+
+def activation_layer(act_name):
+    """Construct activation layers
+
+    Args:
+        act_name: str or nn.Module, name of activation function
+    
+    Returns:
+        act_layer: activation layer
+    """
+    if isinstance(act_name, str):
+        if act_name.lower() == 'sigmoid':
+            act_layer = nn.Sigmoid()
+        elif act_name.lower() == 'relu':
+            act_layer = nn.ReLU(inplace=True)
+        elif act_name.lower() == 'dice':
+            act_layer = Dice()
+        elif act_name.lower() == 'prelu':
+            act_layer = nn.PReLU()
+        elif act_name.lower() == "softmax":
+            act_layer = nn.Softmax(dim=1)
+        elif act_name.lower() == 'leakyrelu':
+            act_layer = nn.LeakyReLU()
+    elif issubclass(act_name, nn.Module):
+        act_layer = act_name()
+    else:
+        raise NotImplementedError
+    return act_layer

{torch-rechub-0.0.1 → torch_rechub-0.0.3}/torch_rechub/basic/callback.py

@@ -1,33 +1,33 @@
-import copy
-
-
-class EarlyStopper(object):
-    """Early stops the training if validation loss doesn't improve after a given patience.
-        
-    Args:
-        patience (int): How long to wait after last time validation auc improved.
-    """
-
-    def __init__(self, patience):
-        self.patience = patience
-        self.trial_counter = 0
-        self.best_auc = 0
-        self.best_weights = None
-
-    def stop_training(self, val_auc, weights):
-        """whether to stop training.
-
-        Args:
-            val_auc (float): auc score in val data.
-            weights (tensor): the weights of model
-        """
-        if val_auc > self.best_auc:
-            self.best_auc = val_auc
-            self.trial_counter = 0
-            self.best_weights = copy.deepcopy(weights)
-            return False
-        elif self.trial_counter + 1 < self.patience:
-            self.trial_counter += 1
-            return False
-        else:
+import copy
+
+
+class EarlyStopper(object):
+    """Early stops the training if validation loss doesn't improve after a given patience.
+        
+    Args:
+        patience (int): How long to wait after last time validation auc improved.
+    """
+
+    def __init__(self, patience):
+        self.patience = patience
+        self.trial_counter = 0
+        self.best_auc = 0
+        self.best_weights = None
+
+    def stop_training(self, val_auc, weights):
+        """whether to stop training.
+
+        Args:
+            val_auc (float): auc score in val data.
+            weights (tensor): the weights of model
+        """
+        if val_auc > self.best_auc:
+            self.best_auc = val_auc
+            self.trial_counter = 0
+            self.best_weights = copy.deepcopy(weights)
+            return False
+        elif self.trial_counter + 1 < self.patience:
+            self.trial_counter += 1
+            return False
+        else:
             return True