nextrec 0.1.1__py3-none-any.whl → 0.1.2__py3-none-any.whl

nextrec/utils/__init__.py

@@ -6,13 +6,13 @@ from nextrec.utils.common import get_task_type
 from nextrec.utils import optimizer, initializer, embedding, common
 
 __all__ = [
-    'get_optimizer_fn',
-    'get_scheduler_fn',
-    'get_initializer_fn',
-    'get_auto_embedding_dim',
-    'get_task_type',
-    'optimizer',
-    'initializer',
-    'embedding',
-    'common',
+    "get_optimizer_fn",
+    "get_scheduler_fn",
+    "get_initializer_fn",
+    "get_auto_embedding_dim",
+    "get_task_type",
+    "optimizer",
+    "initializer",
+    "embedding",
+    "common",
 ]

nextrec/utils/embedding.py

@@ -13,7 +13,7 @@ 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: 
+    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

@@ -9,10 +9,10 @@ Author:
 import torch.nn as nn
 
 
-def get_initializer_fn(init_type='normal', activation='linear', param=None):
+def get_initializer_fn(init_type="normal", activation="linear", param=None):
     """
     Get parameter initialization function.
-        
+
     Examples:
         >>> init_fn = get_initializer_fn('xavier_uniform', 'relu')
         >>> init_fn(tensor)
@@ -21,25 +21,33 @@ def get_initializer_fn(init_type='normal', activation='linear', param=None):
     param = param or {}
 
     try:
-        gain = param.get('gain', nn.init.calculate_gain(activation, param.get('param', None)))
+        gain = param.get(
+            "gain", nn.init.calculate_gain(activation, param.get("param", None))
+        )
     except ValueError:
         gain = 1.0  # for custom activations like 'dice'
-    
+
     def initializer_fn(tensor):
-        if init_type == 'xavier_uniform':
+        if init_type == "xavier_uniform":
             nn.init.xavier_uniform_(tensor, gain=gain)
-        elif init_type == 'xavier_normal':
+        elif init_type == "xavier_normal":
             nn.init.xavier_normal_(tensor, gain=gain)
-        elif init_type == 'kaiming_uniform':
-            nn.init.kaiming_uniform_(tensor, a=param.get('a', 0), nonlinearity=activation)
-        elif init_type == 'kaiming_normal':
-            nn.init.kaiming_normal_(tensor, a=param.get('a', 0), nonlinearity=activation)
-        elif init_type == 'orthogonal':
+        elif init_type == "kaiming_uniform":
+            nn.init.kaiming_uniform_(
+                tensor, a=param.get("a", 0), nonlinearity=activation
+            )
+        elif init_type == "kaiming_normal":
+            nn.init.kaiming_normal_(
+                tensor, a=param.get("a", 0), nonlinearity=activation
+            )
+        elif init_type == "orthogonal":
             nn.init.orthogonal_(tensor, gain=gain)
-        elif init_type == 'normal':
-            nn.init.normal_(tensor, mean=param.get('mean', 0.0), std=param.get('std', 0.0001))
-        elif init_type == 'uniform':
-            nn.init.uniform_(tensor, a=param.get('a', -0.05), b=param.get('b', 0.05))
+        elif init_type == "normal":
+            nn.init.normal_(
+                tensor, mean=param.get("mean", 0.0), std=param.get("std", 0.0001)
+            )
+        elif init_type == "uniform":
+            nn.init.uniform_(tensor, a=param.get("a", -0.05), b=param.get("b", 0.05))
         else:
             raise ValueError(f"Unknown init_type: {init_type}")
         return tensor

nextrec/utils/optimizer.py

@@ -13,11 +13,11 @@ from typing import Iterable
 def get_optimizer_fn(
     optimizer: str = "adam",
     params: Iterable[torch.nn.Parameter] | None = None,
-    **optimizer_params
+    **optimizer_params,
 ):
     """
     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)
@@ -25,9 +25,9 @@ def get_optimizer_fn(
     if params is None:
         raise ValueError("params cannot be None. Please provide model parameters.")
 
-    if 'lr' not in optimizer_params:
-        optimizer_params['lr'] = 1e-3
-    
+    if "lr" not in optimizer_params:
+        optimizer_params["lr"] = 1e-3
+
     if isinstance(optimizer, str):
         opt_name = optimizer.lower()
         if opt_name == "adam":
@@ -48,28 +48,32 @@ def get_optimizer_fn(
         optimizer_fn = optimizer
     else:
         raise TypeError(f"Invalid optimizer type: {type(optimizer)}")
-    
+
     return optimizer_fn
 
 
 def get_scheduler_fn(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)
     """
     if isinstance(scheduler, str):
         if scheduler == "step":
-            scheduler_fn = torch.optim.lr_scheduler.StepLR(optimizer, **scheduler_params)
+            scheduler_fn = torch.optim.lr_scheduler.StepLR(
+                optimizer, **scheduler_params
+            )
         elif scheduler == "cosine":
-            scheduler_fn = torch.optim.lr_scheduler.CosineAnnealingLR(optimizer, **scheduler_params)
+            scheduler_fn = torch.optim.lr_scheduler.CosineAnnealingLR(
+                optimizer, **scheduler_params
+            )
         else:
             raise NotImplementedError(f"Unsupported scheduler: {scheduler}")
     elif isinstance(scheduler, torch.optim.lr_scheduler._LRScheduler):
         scheduler_fn = scheduler
     else:
         raise TypeError(f"Invalid scheduler type: {type(scheduler)}")
-    
+
     return scheduler_fn

{nextrec-0.1.1.dist-info → nextrec-0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nextrec
-Version: 0.1.1
+Version: 0.1.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
@@ -20,7 +20,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Requires-Python: >=3.10
 Requires-Dist: fastparquet>=2023.4.0
-Requires-Dist: numpy>=1.24.0
+Requires-Dist: numpy>=1.23.0
 Requires-Dist: pandas>=2.0.0
 Requires-Dist: pyarrow>=12.0.0
 Requires-Dist: scikit-learn>=1.3.0
@@ -72,47 +72,13 @@ NextRec is a modern recommendation system framework built on PyTorch, providing
 
 ## Installation
 
-NextRec supports installation via **UV** or traditional **pip/source installation**.
-
-### Option 1: Using UV (Recommended)
-
-UV is a modern, high-performance Python package manager offering fast dependency resolution and installation.
-
-```bash
-git clone https://github.com/zerolovesea/NextRec.git
-cd NextRec
-
-# Install UV if not already installed
-pip install uv
-
-# Create virtual environment and install dependencies
-uv sync
-
-# Activate the virtual environment
-source .venv/bin/activate  # macOS/Linux
-# or
-.venv\Scripts\activate     # Windows
-
-# Install the package in editable mode
-uv pip install -e .
-```
-
-**Note**: Make sure to deactivate any other conda/virtual environments before running `uv sync` to avoid environment conflicts.
-
-### Option 2: Using pip/source installation
-
 ```bash
-git clone https://github.com/zerolovesea/NextRec.git
-cd NextRec
-
-# Install dependencies
-pip install -r requirements.txt
-pip install -r test_requirements.txt
+# release version
+pip install nextrec
 
-# Install the package in editable mode
-pip install -e .
+# pre-release version
+pip install -i https://test.pypi.org/simple/ nextrec
 ```
-
 ---
 
 ## 5-Minute Quick Start

nextrec-0.1.2.dist-info/RECORD

@@ -0,0 +1,51 @@
+nextrec/__init__.py,sha256=QmyGxhPAZHcl-znnAHyqEsx-PssA1y9JhRsAiaAteXY,1114
+nextrec/__version__.py,sha256=YvuYzWnKtqBb-IqG8HAu-nhIYAsgj9Vmc_b9o7vO-js,22
+nextrec/basic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nextrec/basic/activation.py,sha256=-Tjeb2vNIB530dUGS_mxV8QGqIHaF87qnuD580f80hI,2760
+nextrec/basic/callback.py,sha256=1zBZI0jDi_NfvfCW8nRYy_ZwmVZ-rcgMNNzNgPxB5uU,1040
+nextrec/basic/dataloader.py,sha256=F0J-Gj-SqEkCSaCUgIrYs87Ivgcq6G1plnF_s3GvJ6I,18685
+nextrec/basic/features.py,sha256=tdbLTaTUyROkJ4JVdXk0pJ4lJQgBopJXNz5xQbESudk,2343
+nextrec/basic/layers.py,sha256=BzrEvhTq8ZCJ6t1mK-6uoUwMbu_qbVqTr56HDZQiA1c,39784
+nextrec/basic/loggers.py,sha256=M4IEhi4dIfW-Glvk7FPkIqNhVjvKJywRVPbbDx1pjEM,3552
+nextrec/basic/metrics.py,sha256=MxZZoTJasTJZ87qZC2lVSCxJIeXInNjuOF8J_vabMOo,21289
+nextrec/basic/model.py,sha256=-IpQWeo8c91Fs6vFW-diZ3zUVJbBGIbzKh5BsIRLLa8,70141
+nextrec/data/__init__.py,sha256=DdXxJq8lw2fjyrMUygOXA-1sBN245YQnN8zZO55JIWI,524
+nextrec/data/data_utils.py,sha256=hMq5fxjlmjr187DSVR1-Jv-L5tJ_BlEsAu7F2U7qG14,4124
+nextrec/data/preprocessor.py,sha256=ewqJAl7YJ9fx5kr_pUgZIsxG5cH0WjM04izslhDnp6o,25891
+nextrec/loss/__init__.py,sha256=JoM2AJ0NdjxGZNq2xtaHkyC9seBj9gwEBgNqt01pvsg,647
+nextrec/loss/loss_utils.py,sha256=TVDXSflTZ95E-MtkM4Fr82jGfBjgrCOjTvpl4fXzq78,4706
+nextrec/loss/match_losses.py,sha256=KhIQuKZ9uxQkE1-gexXz5RqPImYHcCWsUTOUt2edJts,11660
+nextrec/models/generative/hstu.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nextrec/models/generative/tiger.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nextrec/models/match/__init__.py,sha256=gX5UYw366SZZasc5fYucuG36j57bftzQVXNwv2h-1dI,215
+nextrec/models/match/dssm.py,sha256=flgeIiUBCzbzrLqY-TTIHXXpu2ij83mFc90llxJC-Lw,7383
+nextrec/models/match/dssm_v2.py,sha256=bI5OWA3ZFIAIYELsBzhuf8KT66zGxbpQN2QOxFNd9L0,6145
+nextrec/models/match/mind.py,sha256=xFoVuLZ5ivu1dYb_MXWtK7iB68WfHdEn35rDcX1btbM,8506
+nextrec/models/match/sdm.py,sha256=PGbsfcKRaDcPyOJX62BErqdhsSs7igHsvmLvv8clAH8,9855
+nextrec/models/match/youtube_dnn.py,sha256=AtHryjaSYc9rMElQr0UXrf538MNcKI8_h8R60C46gVk,6563
+nextrec/models/multi_task/esmm.py,sha256=VgELfENaVe1rFZRhKxnxh10XlAagyjGVDpprpyqGWsI,4671
+nextrec/models/multi_task/mmoe.py,sha256=bZYuyh1LtmLRnPnIVlwfE9NfSgABwyHxwyxj7UwvSyo,5950
+nextrec/models/multi_task/ple.py,sha256=khpkYHI61NwQAf9JJ8BMKT5PGkMCExtNUt1sd050lOU,11393
+nextrec/models/multi_task/share_bottom.py,sha256=KMgOJKxq2Y2zT_ETlqzfhwuH92SdL-tUEkxVz0ThtOE,4309
+nextrec/models/ranking/__init__.py,sha256=sAFJT2DMBxXdtg1csHBQqQYTHCn0x8KbTVwM32PQ8m8,290
+nextrec/models/ranking/afm.py,sha256=WA_YKyRvDDbA0FQzTOYwkmtKdSEGju8s4w2aeReyFX0,4456
+nextrec/models/ranking/autoint.py,sha256=rYnyQMjvk4HrwJEZm6HQti1jq57rcUzWBzYb2B_fyhE,5541
+nextrec/models/ranking/dcn.py,sha256=Dv6IA51R3nDYWL_w1gpm7hLeJMEpV7Q-7K2xv0n0lEM,4042
+nextrec/models/ranking/deepfm.py,sha256=0_I6n_x1D9he6-t_l47-Es46-8syhASwQ9B_uUTKl3Y,3376
+nextrec/models/ranking/dien.py,sha256=JQfNWAKlCwA6AxdqOvyKGVJERr1iwES3cd2F-i4gPD4,8503
+nextrec/models/ranking/din.py,sha256=fEg1YszZuHICsrVxOYylcNWBl68KTlyz4rIeHcw-qRQ,7104
+nextrec/models/ranking/fibinet.py,sha256=UI1ZOISooSXZrvweLZH3mNLhmfuIlKF1pXCHRtMOG3I,4825
+nextrec/models/ranking/fm.py,sha256=zQn2KxBFrVf_6DNFgVlb5UdpCq5WPScJAwk8NSd0OmY,2725
+nextrec/models/ranking/masknet.py,sha256=9iVlF7UDpq446HGB4GrxY8qweelZvzjilCzMhwzosXU,4390
+nextrec/models/ranking/pnn.py,sha256=iTwGBZU1dl1rQSp-SPiaQt91L8j6NPFsSQd4mj7Ta7g,4703
+nextrec/models/ranking/widedeep.py,sha256=b60sQMRkn_rNTq2bqfFQe2JrRRQaY0mIAmM1i0hTUKc,3532
+nextrec/models/ranking/xdeepfm.py,sha256=gAyxHi-JLnam5dg2yIEGHoxsrKafO91cupO9MCQpnS4,4068
+nextrec/utils/__init__.py,sha256=S5cKbGm2xwQfUUSofwoFG901c7rGj0FL_IgTu1Fyiqc,510
+nextrec/utils/common.py,sha256=-LrRY1MFAhgeyZkKyqdVQGxev6eH3gigNtlRKw5f8Iw,214
+nextrec/utils/embedding.py,sha256=8U49AANGMdTUlxsDMIQHcFqZA63nh_mpqGrCy0FdGbw,477
+nextrec/utils/initializer.py,sha256=IdOB6jbizKEIHp5fvpwJQMMH22J3mVIHu5osXAG_7eo,1760
+nextrec/utils/optimizer.py,sha256=MPbCUQrqiAf91v21xkiZkzeSa_oernWpuH4iAP5uBgU,2505
+nextrec-0.1.2.dist-info/METADATA,sha256=pNpRM_std3ZoYokYXvigQDn8p-ahIzs_rIRA6-gfLxE,10230
+nextrec-0.1.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+nextrec-0.1.2.dist-info/licenses/LICENSE,sha256=2fQfVKeafywkni7MYHyClC6RGGC3laLTXCNBx-ubtp0,1064
+nextrec-0.1.2.dist-info/RECORD,,

nextrec-0.1.1.dist-info/RECORD

@@ -1,51 +0,0 @@
-nextrec/__init__.py,sha256=CvocnY2uBp0cjNkhrT6ogw0q2bN9s1GNp754FLO-7lo,1117
-nextrec/__version__.py,sha256=rnObPjuBcEStqSO0S6gsdS_ot8ITOQjVj_-P1LUUYpg,22
-nextrec/basic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-nextrec/basic/activation.py,sha256=XJDTFzmacpLq8DMNbFVhZ3WhlOmKDE88vp0udnVpXtE,2808
-nextrec/basic/callback.py,sha256=c0QeolbPJzCYhJnPf9rrZwFU13zmLxg59nvQGbpetNo,1039
-nextrec/basic/dataloader.py,sha256=roG1a7VRPpdy9XBv0rJg7wz00ggok9WNHU_EoDIxY2c,18898
-nextrec/basic/features.py,sha256=wJbiDqE_qWA5gArUm-NYHaLgk7AMxpA7loaovf84dSU,2526
-nextrec/basic/layers.py,sha256=dvMir_0PJQfZv0uCUeqyiJpb-QOz0f2CUu2Cuuxh7iA,38300
-nextrec/basic/loggers.py,sha256=0fupxPiHrKcBEJTBm0Sjcim0rU-n0gYKuy6IiCYX1Bw,3480
-nextrec/basic/metrics.py,sha256=p79-IRRprLcXjjicrG41vM0zwRGtUY5tTPoybpvz-io,20402
-nextrec/basic/model.py,sha256=Z6U4p5i-lNY0ypZWoR3PAcQc1d3XyiEAasUl6Z3AQf4,65859
-nextrec/data/__init__.py,sha256=vvBNAdHcVO54aaaT-SyYHWsPHhoH8GvrlZ2hMRjqyF8,524
-nextrec/data/data_utils.py,sha256=rpcj5CIWw8RlLn1NYva_gEOlpYG1cy65rB1BSv23XAM,4113
-nextrec/data/preprocessor.py,sha256=0gYc_nH6ek3QxgncSZ8B8KyYmIYdCFMx9rSEdo4-aFw,26442
-nextrec/loss/__init__.py,sha256=kBanUB5rxQKwXTd6f-2hOI_CF7cp_MClAwAeVXIkpig,647
-nextrec/loss/loss_utils.py,sha256=3zeeLBG4lNIXCO94jx-BYlSHl14t-U7L06dQuzVSPJ8,4752
-nextrec/loss/match_losses.py,sha256=BaH4GKVSFU_PNhHPP_JuAM5zwjOIPxcbuNLYpK0-EWA,11652
-nextrec/models/generative/hstu.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-nextrec/models/generative/tiger.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-nextrec/models/match/__init__.py,sha256=ASZB5abqKPhDbk8NErNNNa0DHuWpsVxvUtyEn5XMx6Y,215
-nextrec/models/match/dssm.py,sha256=rl-8-4pG5_DgxM0VYZuPzLP1lhvDF1BbQQoqxBMMqYw,7702
-nextrec/models/match/dssm_v2.py,sha256=eyWrCo8g8y-e_fq5168iTA_xuHdYWBT9v96GaPor6-o,6407
-nextrec/models/match/mind.py,sha256=5g7b-VOShPQ9D4FG-1z8exKYFLJS_z_Lt2bvU_qSC98,8735
-nextrec/models/match/sdm.py,sha256=rJK49438-49JvzNQX2Vi6Zn1sn9twjyOb2YG2lVaGlc,10238
-nextrec/models/match/youtube_dnn.py,sha256=Su5kwrHGRXrv_4psXZgr9hXpUF5bdosXqdmtHb5J2Vs,6834
-nextrec/models/multi_task/esmm.py,sha256=0dn8pJ7BAQh5oqpNZISSiTb6sgXddsG99eOdpQVMSTU,4817
-nextrec/models/multi_task/mmoe.py,sha256=vly9c8e-Xc_m9AjWUmTGtidf67bjiHPwwbAFbXc0XpM,6099
-nextrec/models/multi_task/ple.py,sha256=mM8shre3BX-sg_peokMh35_-wQAMG5UI2eUfhyRzTgs,11269
-nextrec/models/multi_task/share_bottom.py,sha256=MzShugQya1rSovhbvmTDD4Uf1MRCGfgIKqKXVsz0RTo,4451
-nextrec/models/ranking/__init__.py,sha256=GMn3R5TkE9W17dzHuQoASJsQCoM_EIHuUhnMS2jMdZw,291
-nextrec/models/ranking/afm.py,sha256=BZvGyJZ9aAoL3P8ebsMoQ9HqX2UyKkFdktfz3_VMalA,4483
-nextrec/models/ranking/autoint.py,sha256=D9jeEP0w-IssbporOIPzTzi6PveiYVcgN7D6AXYxyLc,5580
-nextrec/models/ranking/dcn.py,sha256=HyXXzooS1zqOWU6MAPi6tBdmDs4o64HP9vBV5fYdKO4,4134
-nextrec/models/ranking/deepfm.py,sha256=Yl95d4r0dytcZSn4A8ukgxOQ8eaF0t5MqDd9KPfkdPI,3453
-nextrec/models/ranking/dien.py,sha256=2maimf_c6L-I0JpJNbmpIjbMV8uCndrdFiqvjwxMaj8,8401
-nextrec/models/ranking/din.py,sha256=Qs4IxfvCmT2lGtZ6BvgdzMoT0lCy88yaXE1FecaMo2c,7122
-nextrec/models/ranking/fibinet.py,sha256=h6a738bo3VikKHKZhOzk_p9YGNs7hWcpEOkJvOMDR88,4779
-nextrec/models/ranking/fm.py,sha256=WsbQV8RUc2O7b66GRZicNWaWOtin_QLO8e_Skjk5aIY,2887
-nextrec/models/ranking/masknet.py,sha256=ADki3oMR7PwWgcf5GhIUQJxto-gFNmIlU-GRsdi04Jk,4565
-nextrec/models/ranking/pnn.py,sha256=ZhsUh-O_kLJLfK28dp81DMGYnzMkO-L86CgESlT2TB0,4883
-nextrec/models/ranking/widedeep.py,sha256=7EylqHFaxrclRr-PVhKRxBLOOf8E5-AJbWfJqZpdzy0,3642
-nextrec/models/ranking/xdeepfm.py,sha256=p2PrQHxmvABdQl1wLnP5VyRy5Chdp7Xcw1FJw7m1LFY,4200
-nextrec/utils/__init__.py,sha256=-wyEzZrYQ9QL5zPbWdBIWzg-HbT-2wmmbH2Kceuzlzk,510
-nextrec/utils/common.py,sha256=-LrRY1MFAhgeyZkKyqdVQGxev6eH3gigNtlRKw5f8Iw,214
-nextrec/utils/embedding.py,sha256=Xl5bXAdxdGc0FV3FthNqJe9MP0M_rZI1uaOlPi3vLj8,478
-nextrec/utils/initializer.py,sha256=ka5sgXWqAb9x5hQS6ypgonR93OUajBVUAwO7q-JPjIE,1660
-nextrec/utils/optimizer.py,sha256=g9IETUdflM89YKSzInP_iS_hTnDy_cjpm6Wcq9V9_vE,2468
-nextrec-0.1.1.dist-info/METADATA,sha256=AvRHx-l50RENWL-w5EA2xSwNEmtxF1mqz1XHddfGSKY,11113
-nextrec-0.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-nextrec-0.1.1.dist-info/licenses/LICENSE,sha256=2fQfVKeafywkni7MYHyClC6RGGC3laLTXCNBx-ubtp0,1064
-nextrec-0.1.1.dist-info/RECORD,,