Add README.md

README.md

@@ -0,0 +1,46 @@
+## Click Models
+
+### Create Datasets
+
+```Python
+from ultr_toolbox.click_models.data import ClickDataset
+
+train_dataset = ClickDataset(train_df)
+val_dataset = ClickDataset(val_df)
+test_dataset = ClickDataset(test_df)
+```
+
+### Train neural click models
+```
+from ultr_toolbox.click_models.metrics import Perplexity
+from ultr_toolbox.click_models.neural import PositionBasedModel, NeuralTrainer
+
+model = PositionBasedModel()
+trainer = NeuralTrainer(model)
+trainer.fit(train_dataset, val_dataset)
+metrics = trainer.test(test_dataset, metrics=[Perplexity()])
+```
+
+### Train PyClick models
+```
+from pyclick.click_models import PBM
+
+from ultr_toolbox.click_models.metrics import Perplexity
+from ultr_toolbox.click_models.em import PyClickTrainer
+
+model = PBM()
+trainer = PyClickTrainer(model)
+trainer.fit(train_dataset, val_dataset)
+metrics = trainer.test(test_dataset, metrics=[Perplexity()])
+```
+
+### Train naive models based on click statistics
+```
+from ultr_toolbox.click_models.metrics import Perplexity
+from ultr_toolbox.click_models.stats import StatsTrainer, RankDocumentBasedModel
+
+model = RankDocumentBasedModel()
+trainer = StatsTrainer(model)
+trainer.fit(train_dataset, val_dataset)
+metrics = trainer.test(test_dataset, metrics=[Perplexity()])
+```