nextrec 0.1.11__py3-none-any.whl → 0.2.2__py3-none-any.whl

nextrec/models/multi_task/share_bottom.py

@@ -1,9 +1,7 @@
 """
 Date: create on 09/11/2025
-Author:
-    Yang Zhou,zyaztec@gmail.com
-Reference:
-    [1] Caruana R. Multitask learning[J]. Machine learning, 1997, 28: 41-75.
+Author: Yang Zhou,zyaztec@gmail.com
+Reference: [1] Caruana R. Multitask learning[J]. Machine learning, 1997, 28: 41-75.
 """
 
 import torch
@@ -35,12 +33,13 @@ class ShareBottom(BaseModel):
                  optimizer: str = "adam",
                  optimizer_params: dict = {},
                  loss: str | nn.Module | list[str | nn.Module] | None = "bce",
+                 loss_params: dict | list[dict] | None = None,
                  device: str = 'cpu',
-                 model_id: str = "baseline",
                  embedding_l1_reg=1e-6,
                  dense_l1_reg=1e-5,
                  embedding_l2_reg=1e-5,
-                 dense_l2_reg=1e-4):
+                 dense_l2_reg=1e-4,
+                 **kwargs):
         
         super(ShareBottom, self).__init__(
             dense_features=dense_features,
@@ -54,7 +53,7 @@ class ShareBottom(BaseModel):
             embedding_l2_reg=embedding_l2_reg,
             dense_l2_reg=dense_l2_reg,
             early_stop_patience=20,
-            model_id=model_id
+            **kwargs
         )
 
         self.loss = loss
@@ -105,7 +104,8 @@ class ShareBottom(BaseModel):
         self.compile(
             optimizer=optimizer,
             optimizer_params=optimizer_params,
-            loss=loss
+            loss=loss,
+            loss_params=loss_params,
         )
 
     def forward(self, x):

nextrec/models/ranking/__init__.py

@@ -1,3 +1,7 @@
+from .fm import FM
+from .afm import AFM
+from .masknet import MaskNet
+from .pnn import PNN
 from .deepfm import DeepFM
 from .autoint import AutoInt
 from .widedeep import WideDeep
@@ -14,4 +18,8 @@ __all__ = [
     'DCN',
     'DIN',
     'DIEN',
+    'FM',
+    'AFM',
+    'MaskNet',
+    'PNN',
 ]

nextrec/models/ranking/afm.py

@@ -34,12 +34,12 @@ class AFM(BaseModel):
                  optimizer: str = "adam",
                  optimizer_params: dict = {},
                  loss: str | nn.Module | None = "bce",
+                 loss_params: dict | list[dict] | None = None,
                  device: str = 'cpu',
-                 model_id: str = "baseline",
                  embedding_l1_reg=1e-6,
                  dense_l1_reg=1e-5,
                  embedding_l2_reg=1e-5,
-                 dense_l2_reg=1e-4):
+                 dense_l2_reg=1e-4, **kwargs):
         
         super(AFM, self).__init__(
             dense_features=dense_features,
@@ -53,7 +53,7 @@ class AFM(BaseModel):
             embedding_l2_reg=embedding_l2_reg,
             dense_l2_reg=dense_l2_reg,
             early_stop_patience=20,
-            model_id=model_id
+            **kwargs
         )
 
         self.loss = loss
@@ -89,7 +89,8 @@ class AFM(BaseModel):
         self.compile(
             optimizer=optimizer,
             optimizer_params=optimizer_params,
-            loss=loss
+            loss=loss,
+            loss_params=loss_params,
         )
 
     def forward(self, x):

nextrec/models/ranking/autoint.py

@@ -39,12 +39,13 @@ class AutoInt(BaseModel):
                  optimizer: str = "adam",
                  optimizer_params: dict = {},
                  loss: str | nn.Module | None = "bce",
+                 loss_params: dict | list[dict] | None = None,
                  device: str = 'cpu',
-                 model_id: str = "baseline",
                  embedding_l1_reg=1e-6,
                  dense_l1_reg=1e-5,
                  embedding_l2_reg=1e-5,
-                 dense_l2_reg=1e-4):
+                 dense_l2_reg=1e-4,
+                 **kwargs):
         
         super(AutoInt, self).__init__(
             dense_features=dense_features,
@@ -58,7 +59,7 @@ class AutoInt(BaseModel):
             embedding_l2_reg=embedding_l2_reg,
             dense_l2_reg=dense_l2_reg,
             early_stop_patience=20,
-            model_id=model_id
+            **kwargs
         )
 
         self.loss = loss
@@ -113,7 +114,8 @@ class AutoInt(BaseModel):
         self.compile(
             optimizer=optimizer,
             optimizer_params=optimizer_params,
-            loss=loss
+            loss=loss,
+            loss_params=loss_params,
         )
 
     def forward(self, x):

nextrec/models/ranking/dcn.py

@@ -35,12 +35,13 @@ class DCN(BaseModel):
                  optimizer: str = "adam",
                  optimizer_params: dict = {},
                  loss: str | nn.Module | None = "bce",
+                 loss_params: dict | list[dict] | None = None,
                  device: str = 'cpu',
-                 model_id: str = "baseline",
                  embedding_l1_reg=1e-6,
                  dense_l1_reg=1e-5,
                  embedding_l2_reg=1e-5,
-                 dense_l2_reg=1e-4):
+                 dense_l2_reg=1e-4,
+                 **kwargs):
         
         super(DCN, self).__init__(
             dense_features=dense_features,
@@ -54,7 +55,7 @@ class DCN(BaseModel):
             embedding_l2_reg=embedding_l2_reg,
             dense_l2_reg=dense_l2_reg,
             early_stop_patience=20,
-            model_id=model_id
+            **kwargs
         )
 
         self.loss = loss
@@ -97,7 +98,8 @@ class DCN(BaseModel):
         self.compile(
             optimizer=optimizer,
             optimizer_params=optimizer_params,
-            loss=loss
+            loss=loss,
+            loss_params=loss_params,
         )
 
     def forward(self, x):

nextrec/models/ranking/deepfm.py

@@ -31,12 +31,12 @@ class DeepFM(BaseModel):
                  optimizer: str = "adam",
                  optimizer_params: dict = {},
                  loss: str | nn.Module | None = "bce",
+                 loss_params: dict | list[dict] | None = None,
                  device: str = 'cpu',
-                 model_id: str = "baseline",
                  embedding_l1_reg=1e-6,
                  dense_l1_reg=1e-5,
                  embedding_l2_reg=1e-5,
-                 dense_l2_reg=1e-4):
+                 dense_l2_reg=1e-4, **kwargs):
         
         super(DeepFM, self).__init__(
             dense_features=dense_features,
@@ -50,7 +50,7 @@ class DeepFM(BaseModel):
             embedding_l2_reg=embedding_l2_reg,
             dense_l2_reg=dense_l2_reg,
             early_stop_patience=20,
-            model_id=model_id
+            **kwargs
         )
 
         self.loss = loss
@@ -80,7 +80,8 @@ class DeepFM(BaseModel):
         self.compile(
             optimizer=optimizer,
             optimizer_params=optimizer_params,
-            loss=loss
+            loss=loss,
+            loss_params=loss_params,
         )
 
     def forward(self, x):

nextrec/models/ranking/dien.py

@@ -38,12 +38,13 @@ class DIEN(BaseModel):
                  optimizer: str = "adam",
                  optimizer_params: dict = {},
                  loss: str | nn.Module | None = "bce",
+                 loss_params: dict | list[dict] | None = None,
                  device: str = 'cpu',
-                 model_id: str = "baseline",
                  embedding_l1_reg=1e-6,
                  dense_l1_reg=1e-5,
                  embedding_l2_reg=1e-5,
-                 dense_l2_reg=1e-4):
+                 dense_l2_reg=1e-4,
+                 **kwargs):
         
         super(DIEN, self).__init__(
             dense_features=dense_features,
@@ -57,7 +58,7 @@ class DIEN(BaseModel):
             embedding_l2_reg=embedding_l2_reg,
             dense_l2_reg=dense_l2_reg,
             early_stop_patience=20,
-            model_id=model_id
+            **kwargs
         )
 
         self.loss = loss
@@ -128,7 +129,8 @@ class DIEN(BaseModel):
         self.compile(
             optimizer=optimizer,
             optimizer_params=optimizer_params,
-            loss=loss
+            loss=loss,
+            loss_params=loss_params,
         )
 
     def forward(self, x):

nextrec/models/ranking/din.py

@@ -37,12 +37,13 @@ class DIN(BaseModel):
                  optimizer: str = "adam",
                  optimizer_params: dict = {},
                  loss: str | nn.Module | None = "bce",
+                 loss_params: dict | list[dict] | None = None,
                  device: str = 'cpu',
-                 model_id: str = "baseline",
                  embedding_l1_reg=1e-6,
                  dense_l1_reg=1e-5,
                  embedding_l2_reg=1e-5,
-                 dense_l2_reg=1e-4):
+                 dense_l2_reg=1e-4,
+                 **kwargs):
         
         super(DIN, self).__init__(
             dense_features=dense_features,
@@ -56,7 +57,7 @@ class DIN(BaseModel):
             embedding_l2_reg=embedding_l2_reg,
             dense_l2_reg=dense_l2_reg,
             early_stop_patience=20,
-            model_id=model_id
+            **kwargs
         )
 
         self.loss = loss
@@ -115,7 +116,8 @@ class DIN(BaseModel):
         self.compile(
             optimizer=optimizer,
             optimizer_params=optimizer_params,
-            loss=loss
+            loss=loss,
+            loss_params=loss_params,
         )
 
     def forward(self, x):

nextrec/models/ranking/fibinet.py

@@ -42,12 +42,13 @@ class FiBiNET(BaseModel):
                  optimizer: str = "adam",
                  optimizer_params: dict = {},
                  loss: str | nn.Module | None = "bce",
+                 loss_params: dict | list[dict] | None = None,
                  device: str = 'cpu',
-                 model_id: str = "baseline",
                  embedding_l1_reg=1e-6,
                  dense_l1_reg=1e-5,
                  embedding_l2_reg=1e-5,
-                 dense_l2_reg=1e-4):
+                 dense_l2_reg=1e-4,
+                 **kwargs):
         
         super(FiBiNET, self).__init__(
             dense_features=dense_features,
@@ -61,7 +62,7 @@ class FiBiNET(BaseModel):
             embedding_l2_reg=embedding_l2_reg,
             dense_l2_reg=dense_l2_reg,
             early_stop_patience=20,
-            model_id=model_id
+            **kwargs
         )
 
         self.loss = loss
@@ -111,7 +112,8 @@ class FiBiNET(BaseModel):
         self.compile(
             optimizer=optimizer,
             optimizer_params=optimizer_params,
-            loss=loss
+            loss=loss,
+            loss_params=loss_params,
         )
 
     def forward(self, x):

nextrec/models/ranking/fm.py

@@ -30,12 +30,13 @@ class FM(BaseModel):
                  optimizer: str = "adam",
                  optimizer_params: dict = {},
                  loss: str | nn.Module | None = "bce",
+                 loss_params: dict | list[dict] | None = None,
                  device: str = 'cpu',
-                 model_id: str = "baseline",
                  embedding_l1_reg=1e-6,
                  dense_l1_reg=1e-5,
                  embedding_l2_reg=1e-5,
-                 dense_l2_reg=1e-4):
+                 dense_l2_reg=1e-4,
+                 **kwargs):
         
         super(FM, self).__init__(
             dense_features=dense_features,
@@ -49,7 +50,7 @@ class FM(BaseModel):
             embedding_l2_reg=embedding_l2_reg,
             dense_l2_reg=dense_l2_reg,
             early_stop_patience=20,
-            model_id=model_id
+            **kwargs
         )
 
         self.loss = loss
@@ -76,7 +77,8 @@ class FM(BaseModel):
         self.compile(
             optimizer=optimizer,
             optimizer_params=optimizer_params,
-            loss=loss
+            loss=loss,
+            loss_params=loss_params,
         )
 
     def forward(self, x):

nextrec/models/ranking/masknet.py

@@ -36,12 +36,13 @@ class MaskNet(BaseModel):
                  optimizer: str = "adam",
                  optimizer_params: dict = {},
                  loss: str | nn.Module | None = "bce",
+                 loss_params: dict | list[dict] | None = None,
                  device: str = 'cpu',
-                 model_id: str = "baseline",
                  embedding_l1_reg=1e-6,
                  dense_l1_reg=1e-5,
                  embedding_l2_reg=1e-5,
-                 dense_l2_reg=1e-4):
+                 dense_l2_reg=1e-4,
+                 **kwargs):
         
         super(MaskNet, self).__init__(
             dense_features=dense_features,
@@ -55,7 +56,7 @@ class MaskNet(BaseModel):
             embedding_l2_reg=embedding_l2_reg,
             dense_l2_reg=dense_l2_reg,
             early_stop_patience=20,
-            model_id=model_id
+            **kwargs
         )
 
         self.loss = loss
@@ -98,7 +99,8 @@ class MaskNet(BaseModel):
         self.compile(
             optimizer=optimizer,
             optimizer_params=optimizer_params,
-            loss=loss
+            loss=loss,
+            loss_params=loss_params,
         )
 
     def forward(self, x):

nextrec/models/ranking/pnn.py

@@ -34,12 +34,13 @@ class PNN(BaseModel):
                  optimizer: str = "adam",
                  optimizer_params: dict = {},
                  loss: str | nn.Module | None = "bce",
+                 loss_params: dict | list[dict] | None = None,
                  device: str = 'cpu',
-                 model_id: str = "baseline",
                  embedding_l1_reg=1e-6,
                  dense_l1_reg=1e-5,
                  embedding_l2_reg=1e-5,
-                 dense_l2_reg=1e-4):
+                 dense_l2_reg=1e-4,
+                 **kwargs):
         
         super(PNN, self).__init__(
             dense_features=dense_features,
@@ -53,7 +54,7 @@ class PNN(BaseModel):
             embedding_l2_reg=embedding_l2_reg,
             dense_l2_reg=dense_l2_reg,
             early_stop_patience=20,
-            model_id=model_id
+            **kwargs
         )
 
         self.loss = loss
@@ -98,7 +99,8 @@ class PNN(BaseModel):
         self.compile(
             optimizer=optimizer,
             optimizer_params=optimizer_params,
-            loss=loss
+            loss=loss,
+            loss_params=loss_params,
         )
 
     def forward(self, x):

nextrec/models/ranking/widedeep.py

@@ -34,12 +34,13 @@ class WideDeep(BaseModel):
                  optimizer: str = "adam",
                  optimizer_params: dict = {},
                  loss: str | nn.Module | None = "bce",
+                 loss_params: dict | list[dict] | None = None,
                  device: str = 'cpu',
-                 model_id: str = "baseline",
                  embedding_l1_reg=1e-6,
                  dense_l1_reg=1e-5,
                  embedding_l2_reg=1e-5,
-                 dense_l2_reg=1e-4):
+                 dense_l2_reg=1e-4,
+                 **kwargs):
         
         super(WideDeep, self).__init__(
             dense_features=dense_features,
@@ -53,7 +54,7 @@ class WideDeep(BaseModel):
             embedding_l2_reg=embedding_l2_reg,
             dense_l2_reg=dense_l2_reg,
             early_stop_patience=20,
-            model_id=model_id
+            **kwargs
         )
 
         self.loss = loss
@@ -88,7 +89,8 @@ class WideDeep(BaseModel):
         self.compile(
             optimizer=optimizer,
             optimizer_params=optimizer_params,
-            loss=loss
+            loss=loss,
+            loss_params=loss_params,
         )
 
     def forward(self, x):

nextrec/models/ranking/xdeepfm.py

@@ -37,12 +37,13 @@ class xDeepFM(BaseModel):
                  optimizer: str = "adam",
                  optimizer_params: dict = {},
                  loss: str | nn.Module | None = "bce",
+                 loss_params: dict | list[dict] | None = None,
                  device: str = 'cpu',
-                 model_id: str = "baseline",
                  embedding_l1_reg=1e-6,
                  dense_l1_reg=1e-5,
                  embedding_l2_reg=1e-5,
-                 dense_l2_reg=1e-4):
+                 dense_l2_reg=1e-4,
+                 **kwargs):
         
         super(xDeepFM, self).__init__(
             dense_features=dense_features,
@@ -56,7 +57,7 @@ class xDeepFM(BaseModel):
             embedding_l2_reg=embedding_l2_reg,
             dense_l2_reg=dense_l2_reg,
             early_stop_patience=20,
-            model_id=model_id
+            **kwargs
         )
 
         self.loss = loss
@@ -95,7 +96,8 @@ class xDeepFM(BaseModel):
         self.compile(
             optimizer=optimizer,
             optimizer_params=optimizer_params,
-            loss=loss
+            loss=loss,
+            loss_params=loss_params,
         )
 
     def forward(self, x):

nextrec/utils/__init__.py

@@ -1,18 +1,14 @@
-from nextrec.utils.optimizer import get_optimizer_fn, get_scheduler_fn
-from nextrec.utils.initializer import get_initializer_fn
-from nextrec.utils.embedding import get_auto_embedding_dim
-from nextrec.utils.common import get_task_type
-
-from nextrec.utils import optimizer, initializer, embedding, common
+from .optimizer import get_optimizer, get_scheduler
+from .initializer import get_initializer
+from .embedding import get_auto_embedding_dim
+from . import optimizer, initializer, embedding
 
 __all__ = [
-    'get_optimizer_fn',
-    'get_scheduler_fn',
-    'get_initializer_fn',
+    'get_optimizer',
+    'get_scheduler',
+    'get_initializer',
     'get_auto_embedding_dim',
-    'get_task_type',
     'optimizer',
     'initializer',
     'embedding',
-    'common',
 ]

nextrec/utils/embedding.py

@@ -2,8 +2,7 @@
 Embedding utilities for NextRec
 
 Date: create on 13/11/2025
-Author:
-    Yang Zhou, zyaztec@gmail.com
+Author: Yang Zhou, zyaztec@gmail.com
 """
 
 import numpy as np
@@ -13,7 +12,6 @@ def get_auto_embedding_dim(num_classes: int) -> int:
     """
     Calculate the dim of embedding vector according to number of classes in the category.
     Formula: emb_dim = [6 * (num_classes)^(1/4)]
-    Reference: 
-        Deep & Cross Network for Ad Click Predictions.(ADKDD'17)
+    Reference: Deep & Cross Network for Ad Click Predictions.(ADKDD'17)
     """
     return int(np.floor(6 * np.power(num_classes, 0.25)))

nextrec/utils/initializer.py

@@ -2,21 +2,20 @@
 Initialization utilities for NextRec
 
 Date: create on 13/11/2025
-Author:
-    Yang Zhou, zyaztec@gmail.com
+Author: Yang Zhou, zyaztec@gmail.com
 """
 
 import torch.nn as nn
 
 
-def get_initializer_fn(init_type='normal', activation='linear', param=None):
+def get_initializer(init_type='normal', activation='linear', param=None):
     """
     Get parameter initialization function.
         
     Examples:
-        >>> init_fn = get_initializer_fn('xavier_uniform', 'relu')
+        >>> init_fn = get_initializer('xavier_uniform', 'relu')
         >>> init_fn(tensor)
-        >>> init_fn = get_initializer_fn('normal', param={'mean': 0.0, 'std': 0.01})
+        >>> init_fn = get_initializer('normal', param={'mean': 0.0, 'std': 0.01})
     """
     param = param or {}
 

nextrec/utils/optimizer.py

@@ -2,15 +2,14 @@
 Optimizer and Scheduler utilities for NextRec
 
 Date: create on 13/11/2025
-Author:
-    Yang Zhou, zyaztec@gmail.com
+Author: Yang Zhou, zyaztec@gmail.com
 """
 
 import torch
 from typing import Iterable
 
 
-def get_optimizer_fn(
+def get_optimizer(
     optimizer: str = "adam",
     params: Iterable[torch.nn.Parameter] | None = None,
     **optimizer_params
@@ -19,8 +18,8 @@ def get_optimizer_fn(
     Get optimizer function based on optimizer name or instance.
         
     Examples:
-        >>> optimizer = get_optimizer_fn("adam", model.parameters(), lr=1e-3)
-        >>> optimizer = get_optimizer_fn("sgd", model.parameters(), lr=0.01, momentum=0.9)
+        >>> optimizer = get_optimizer("adam", model.parameters(), lr=1e-3)
+        >>> optimizer = get_optimizer("sgd", model.parameters(), lr=0.01, momentum=0.9)
     """
     if params is None:
         raise ValueError("params cannot be None. Please provide model parameters.")
@@ -52,13 +51,13 @@ def get_optimizer_fn(
     return optimizer_fn
 
 
-def get_scheduler_fn(scheduler, optimizer, **scheduler_params):
+def get_scheduler(scheduler, optimizer, **scheduler_params):
     """
     Get learning rate scheduler function.
     
     Examples:
-        >>> scheduler = get_scheduler_fn("step", optimizer, step_size=10, gamma=0.1)
-        >>> scheduler = get_scheduler_fn("cosine", optimizer, T_max=100)
+        >>> scheduler = get_scheduler("step", optimizer, step_size=10, gamma=0.1)
+        >>> scheduler = get_scheduler("cosine", optimizer, T_max=100)
     """
     if isinstance(scheduler, str):
         if scheduler == "step":

{nextrec-0.1.11.dist-info → nextrec-0.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nextrec
-Version: 0.1.11
+Version: 0.2.2
 Summary: A comprehensive recommendation library with match, ranking, and multi-task learning models
 Project-URL: Homepage, https://github.com/zerolovesea/NextRec
 Project-URL: Repository, https://github.com/zerolovesea/NextRec
@@ -61,7 +61,7 @@ Description-Content-Type: text/markdown
 ![Python](https://img.shields.io/badge/Python-3.10+-blue.svg)
 ![PyTorch](https://img.shields.io/badge/PyTorch-1.10+-ee4c2c.svg)
 ![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)
-![Version](https://img.shields.io/badge/Version-0.1.11-orange.svg)
+![Version](https://img.shields.io/badge/Version-0.2.2-orange.svg)
 
 English | [中文版](README_zh.md)
 
@@ -123,7 +123,7 @@ model = DeepFM(
     mlp_params={"dims": [256, 128], "activation": "relu", "dropout": 0.5},
     target=target,
     device='cpu',
-    model_id="deepfm_with_processor",
+    session_id="deepfm_with_processor",
     embedding_l1_reg=1e-6,
     dense_l1_reg=1e-5,
     embedding_l2_reg=1e-5,