DIN Tutorial: Deep Interest Network#
Sandbox Model — Experimental
This model is part of the CoreRec Sandbox — an experimental collection of algorithms for research and exploration. Sandbox models are not production-tested and may have incomplete implementations. For production-ready models, see the Production Models.
Introduction#
DIN uses local activation (attention) to adaptively learn user interests from historical behaviors based on the candidate item.
Paper: Zhou et al. 2018 - Deep Interest Network for Click-Through Rate Prediction
How DIN Works#
Architecture#
Adaptive Interest Activation:
Behavior Representation: Embed user’s historical items
Local Activation Unit:
Calculates attention weights between each historical item and target item
Relevant items get higher weights
Weighted Pooling: Sum historical embeddings weighted by attention
Final MLP: Combines activated interest with other features
Key Innovation: Not all behaviors are equally relevant - activate based on target item
Architecture:
Historical Items → Embed → Attention(target) → Weighted Sum → Concat → MLP → Prediction
Target Item → Embed ────────────────────────────────────────→ /
Other Features ──────────────────────────────────────────────→ /
Mathematical Foundation#
Attention Weight Calculation:
a(e_i, e_target) = MLP([e_i; e_target; e_i ⊙ e_target; e_i - e_target])
α_i = exp(a_i) / Σ_j exp(a_j)
Activated User Representation:
Interest = Σ_i α_i · e_i
Final Prediction:
ŷ = σ(MLP([Interest; User_features; Item_features; Context]))
Reference Implementation#
Implementation Note
The code examples below are reference implementations for learning purposes. This is a sandbox model and has not been production-tested. Verify behavior thoroughly before using in production.
Step 1: Import and Load Data#
from corerec.sandbox.collaborative_full.nn_base.DIN_base import DIN_base as DIN
from cr_learn import ml_1m
from sklearn.model_selection import train_test_split
import numpy as np
# Load dataset with CORRECT API
data = ml_1m.load() # Returns dict with 'ratings', 'users', 'movies'
ratings_df = data['ratings'] # DataFrame with user_id, movie_id, rating, timestamp
print(f"Loaded {len(ratings_df)} ratings")
# Split data
train_df, test_df = train_test_split(ratings_df, test_size=0.2, random_state=42)
# Extract arrays for model
train_users = train_df['user_id'].values
train_items = train_df['movie_id'].values
train_ratings = train_df['rating'].values
test_users = test_df['user_id'].values
test_items = test_df['movie_id'].values
test_ratings = test_df['rating'].values
Step 2: Initialize Model#
model = DIN(
name="DIN_Model",
item_embed_dim=16,
attention_mlp=[64, 32],
deep_mlp=[256, 128, 64, 32],
activation='dice',
use_bn=True,
epochs=20,
batch_size=256,
learning_rate=0.001,
verbose=True
)
print(f"Initialized {model.name}")
Step 3: Train#
model.fit(
user_ids=train_users,
item_ids=train_items,
ratings=train_ratings
)
print("Training complete!")
Step 4: Predict#
# Single prediction
score = model.predict(user_id=1, item_id=100)
print(f"Predicted score: {score:.3f}")
# Batch predictions
test_predictions = model.batch_predict(list(zip(test_users[:100], test_items[:100])))
Step 5: Recommend#
# Get top-10 recommendations for user
user_id = 1
recommendations = model.recommend(
user_id=user_id,
top_k=10
)
print(f"Top-10 recommendations for User {user_id}:")
for rank, item_id in enumerate(recommendations, 1):
print(f" {rank}. Item {item_id}")
Step 6: Evaluate#
from sklearn.metrics import mean_squared_error
import numpy as np
# Predict all test ratings
test_pred = [model.predict(u, i) for u, i in zip(test_users, test_items)]
rmse = np.sqrt(mean_squared_error(test_ratings, test_pred))
print(f"Test RMSE: {rmse:.4f}")
Step 7: Save & Load#
# Save model
model.save('artifacts/din_model')
# Load model
loaded = DIN.load('artifacts/din_model')
test_score = loaded.predict(1, 100)
print(f"Loaded model prediction: {test_score:.3f}")
Key Takeaways#
When to Use DIN#
✅ Perfect For:
CTR prediction with user history
Diverse user behaviors (browsing different categories)
When relevance to target matters
Short-to-medium sequences (5-30 items)
Display advertising, e-commerce
❌ Not Suitable For:
No user history available
All items equally relevant
Very long sequences (use interest evolution like DIEN)
Static collaborative filtering
Best Practices#
Sequence Length: 5-30 items (shorter than DIEN/SASRec)
Embedding Dimension: 8-32 for items, 4-16 for features
Attention MLP: [64, 32] typically sufficient
Main MLP: [256, 128, 64, 32]
Activation: PReLU (from paper) or Dice activation
Batch Normalization: Use adaptive BN across mini-batches
Regularization: Dropout (0.1-0.2) + L2 on embeddings
Negative Sampling: Important for training efficiency
Scaling & Production Considerations#
If you plan to move this sandbox model toward production use, consider:
Data Volume: Test with realistic dataset sizes; sandbox implementations may not be optimized for large-scale data.
Distributed Training: For datasets exceeding single-machine memory, consider wrapping the model in distributed training frameworks (e.g., PyTorch DDP, Horovod).
Hyperparameter Tuning: Use systematic search (Optuna, Ray Tune) rather than manual tuning. The defaults in sandbox models are not tuned for any specific domain.
Serving Latency: Profile inference time. Some architectures (e.g., attention-based) may need quantization or ONNX export for low-latency serving.
Monitoring: Implement A/B testing and online metrics (CTR, engagement, diversity) before replacing an existing system.
Validation: Write comprehensive unit tests and integration tests before deploying. Sandbox models do not have CI coverage.
Further Reading#
Paper: Zhou et al. 2018 - Deep Interest Network for Click-Through Rate Prediction