Add dataset card for CLAX datasets

#1
by nielsr HF Staff - opened
Files changed (1) hide show
  1. README.md +83 -0
README.md ADDED
@@ -0,0 +1,83 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ task_categories:
3
+ - text-retrieval
4
+ language:
5
+ - en
6
+ tags:
7
+ - click-model
8
+ - information-retrieval
9
+ ---
10
+
11
+ # CLAX Datasets
12
+
13
+ This repository hosts the Yandex and Baidu-ULTR datasets, which are essential for research and development with [CLAX: Fast and Flexible Neural Click Models in JAX](https://huggingface.co/papers/2511.03620). CLAX is a JAX-based library that implements classic click models using modern gradient-based optimization to understand user behavior and improve ranking performance at scale.
14
+
15
+ ## Links
16
+
17
+ * **Paper**: [CLAX: Fast and Flexible Neural Click Models in JAX](https://huggingface.co/papers/2511.03620)
18
+ * **Code (CLAX library)**: https://github.com/philipphager/clax
19
+ * **Project page (CLAX library documentation)**: https://philipphager.github.io/clax/
20
+
21
+ ## Dataset Description
22
+
23
+ The datasets provided here, including the Yandex and the massive Baidu-ULTR dataset (comprising over a billion user sessions), serve as crucial benchmarks for training and evaluating click models. They enable practitioners and researchers to leverage modern deep learning frameworks while preserving the interpretability of classic models. These datasets are fundamental for developing and testing models that analyze user behavior in search and recommendation systems.
24
+
25
+ ## Download Datasets
26
+
27
+ To download these datasets, ensure you have [Git LFS](https://git-lfs.github.com/) installed. Then, clone the repository:
28
+
29
+ ```bash
30
+ git lfs install
31
+ git clone https://huggingface.co/datasets/philipphager/clax-datasets
32
+ ```
33
+
34
+ **Note**: The full datasets require approximately 85GB of disk space. By default, the CLAX library expects datasets at `./clax-datasets/` relative to the project root. To use a custom path, you can update the `dataset_dir` parameter in your experiment's `config.yaml` within the CLAX library code, for example:
35
+
36
+ ```yaml
37
+ dataset_dir: /my/custom/path/to/datasets/
38
+ ```
39
+
40
+ ## Sample Usage
41
+
42
+ The datasets in this repository are intended to be used with the CLAX library for training and evaluating click models. Below is a basic example from the CLAX GitHub repository demonstrating how a `UserBrowsingModel` can be trained:
43
+
44
+ First, install CLAX (requires JAX with CUDA support; refer to JAX documentation for installation):
45
+
46
+ ```bash
47
+ pip install clax-models
48
+ ```
49
+
50
+ Then, you can use the following Python snippet:
51
+
52
+ ```python
53
+ from clax import Trainer, UserBrowsingModel
54
+ from flax import nnx
55
+ from optax import adamw
56
+
57
+ model = UserBrowsingModel(
58
+ query_doc_pairs=100_000_000, # Number of query-document pairs in the dataset
59
+ positions=10, # Number of ranks per result page
60
+ rngs=nnx.Rngs(42), # NNX random number generator
61
+ )
62
+ trainer = Trainer(
63
+ optimizer=adamw(0.003),
64
+ epochs=50,
65
+ )
66
+ train_df = trainer.train(model, train_loader, val_loader)
67
+ test_df = trainer.test(model, test_loader)
68
+ ```
69
+
70
+ For more advanced usage, custom modules, and additional examples, please refer to the [CLAX GitHub repository](https://github.com/philipphager/clax).
71
+
72
+ ## Citation
73
+
74
+ If CLAX or these datasets are useful to you, please consider citing our paper:
75
+
76
+ ```bibtex
77
+ @misc{hager2025clax,
78
+ title = {CLAX: Fast and Flexible Neural Click Models in JAX},
79
+ author = {Philipp Hager and Onno Zoeter and Maarten de Rijke},
80
+ year = {2025},
81
+ booktitle = {arxiv}
82
+ }
83
+ ```