Update README.md by EmmanuelMalherbe · Pull Request #263 · artefactory/choice-learn

EmmanuelMalherbe · 2025-09-08T15:07:45Z

Improve the ReadMe file

gemini-code-assist

Summary of Changes

Hello @EmmanuelMalherbe, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on a minor but important documentation correction within the README.md file. The primary goal is to ensure the accuracy of a bibliographic citation, improving the overall quality and correctness of the project's documentation.

Highlights

Documentation Update: The README.md file has been updated to correct a BibTeX entry for the "Better Capturing Interactions between Products in Retail" paper. The entry type was changed from @Article to @inproceedings, and relevant fields were adjusted to reflect this change.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This PR updates a BibTeX citation in the README.md file. The new entry contains a duplicated year field and some formatting inconsistencies. I've provided a suggestion to correct the entry to ensure it's valid and consistent with the other citations in the file.

gemini-code-assist · 2025-09-08T15:09:15Z

+@inproceedings{Desir2025
  doi = {},
  url = {},
  year = {2025},
  publisher = {},
-  volume = {},
-  number = {},
-  pages = {},
  author = {Jules Désir and Vincent Auriau and Martin Možina and Emmanuel Malherbe},
  title = {Better Capturing Interactions between Products in Retail: Revisited Negative Sampling for Basket Choice Modeling},
-  journal = {} }
+  booktitle={Joint European Conference on Machine Learning and Knowledge Discovery in Databases},
+  year={2025},
+  organization={Springer}
+}


The updated BibTeX entry has a few issues that could cause problems with citation tools and affect readability:

Duplicate year field: The year is specified on both line 271 and 276. Duplicate fields can cause parsing errors.

Empty publisher field: The publisher field on line 272 is empty, while Springer is listed under organization. It's more standard to use the publisher field for the publisher's name.

Inconsistent formatting: There's inconsistent spacing around the = signs (e.g., booktitle=... vs year = ...) and the placement of the closing brace.

I've suggested a cleaned-up version that addresses these points for better correctness and consistency with the other entry in this file.

Suggested change

@inproceedings{Desir2025

doi = {},

url = {},

year = {2025},

publisher = {},

volume = {},

number = {},

pages = {},

author = {Jules Désir and Vincent Auriau and Martin Možina and Emmanuel Malherbe},

title = {Better Capturing Interactions between Products in Retail: Revisited Negative Sampling for Basket Choice Modeling},

journal = {} }

booktitle={Joint European Conference on Machine Learning and Knowledge Discovery in Databases},

year={2025},

organization={Springer}

}

@inproceedings{Desir2025,

doi = {},

url = {},

year = {2025},

author = {Jules Désir and Vincent Auriau and Martin Možina and Emmanuel Malherbe},

title = {Better Capturing Interactions between Products in Retail: Revisited Negative Sampling for Basket Choice Modeling},

booktitle = {Joint European Conference on Machine Learning and Knowledge Discovery in Databases},

publisher = {Springer} }

github-actions · 2025-09-08T15:15:56Z

Coverage Report for Python 3.9

File	Stmts	Miss	Cover	Missing
choice_learn
__init__.py	2	0	100%
tf_ops.py	62	1	98%	283
choice_learn/basket_models
__init__.py	4	0	100%
alea_carta.py	136	21	85%	84–88, 90–94, 96–100, 104, 107, 129, 157, 418–443
base_basket_model.py	211	17	92%	110–111, 122, 140, 183, 252, 353, 458, 555–557, 644, 724, 766–767, 867–868
basic_attention_model.py	78	4	95%	408, 411, 417, 424
shopper.py	171	7	96%	130, 159, 325, 345, 360, 363, 377
choice_learn/basket_models/data
__init__.py	2	0	100%
basket_dataset.py	137	7	95%	71–74, 369, 534, 573
preprocessing.py	94	78	17%	43–45, 128–364
synthetic_dataset.py	72	6	92%	54, 158–163, 203
choice_learn/basket_models/utils
__init__.py	0	0	100%
permutation.py	22	1	95%	37
choice_learn/data
__init__.py	3	0	100%
choice_dataset.py	647	33	95%	198, 250, 283, 421, 463–464, 589, 724, 738, 840, 842, 937, 957–961, 1140, 1159–1161, 1179–1181, 1209, 1214, 1223, 1240, 1281, 1293, 1307, 1346, 1361, 1366, 1395, 1408, 1443–1444
indexer.py	239	23	90%	20, 31, 45, 60–67, 202–204, 219–230, 265, 291, 577
storage.py	161	6	96%	22, 33, 51, 56, 61, 71
store.py	72	72	0%	3–275
choice_learn/datasets
__init__.py	4	0	100%
base.py	393	5	99%	42–43, 153–154, 714
expedia.py	102	83	19%	37–301
tafeng.py	49	0	100%
choice_learn/datasets/data
__init__.py	0	0	100%
choice_learn/models
__init__.py	14	2	86%	15–16
base_model.py	262	13	95%	144, 186, 283, 302, 342, 349, 378, 397, 428–429, 438–439, 540
baseline_models.py	49	0	100%
conditional_logit.py	269	26	90%	49, 52, 54, 85, 88, 91–95, 98–102, 136, 206, 212–216, 351, 388, 445, 520–526, 651, 685, 822, 826
halo_mnl.py	124	2	98%	186, 374
latent_class_base_model.py	286	39	86%	55–61, 273–279, 288, 325–330, 497–500, 605, 624, 665–701, 715, 720, 751–752, 774–775, 869–870, 974
latent_class_mnl.py	62	6	90%	257–261, 296
learning_mnl.py	67	3	96%	157, 182, 188
nested_logit.py	291	12	96%	55, 77, 160, 269, 351, 484, 530, 600, 679, 848, 900, 904
reslogit.py	132	6	95%	285, 360, 369, 374, 382, 432
rumnet.py	236	3	99%	748–751, 982
simple_mnl.py	139	6	96%	167, 275, 347, 355, 357, 359
tastenet.py	94	3	97%	142, 180, 188
choice_learn/toolbox
__init__.py	0	0	100%
assortment_optimizer.py	27	6	78%	28–30, 93–95, 160–162
gurobi_opt.py	236	236	0%	3–675
or_tools_opt.py	230	11	95%	103, 107, 296–305, 315, 319, 607, 611
TOTAL	5179	738	86%

Tests	Skipped	Failures	Errors	Time
210	0 💤	0 ❌	0 🔥	6m 46s ⏱️

github-actions · 2025-09-08T15:16:01Z

Coverage Report for Python 3.10

File	Stmts	Miss	Cover	Missing
choice_learn
__init__.py	2	0	100%
tf_ops.py	62	1	98%	283
choice_learn/basket_models
__init__.py	4	0	100%
alea_carta.py	136	21	85%	84–88, 90–94, 96–100, 104, 107, 129, 157, 418–443
base_basket_model.py	211	17	92%	110–111, 122, 140, 183, 252, 353, 458, 555–557, 644, 724, 766–767, 867–868
basic_attention_model.py	78	4	95%	408, 411, 417, 424
shopper.py	171	7	96%	130, 159, 325, 345, 360, 363, 377
choice_learn/basket_models/data
__init__.py	2	0	100%
basket_dataset.py	137	7	95%	71–74, 369, 534, 573
preprocessing.py	94	78	17%	43–45, 128–364
synthetic_dataset.py	72	6	92%	54, 158–163, 203
choice_learn/basket_models/utils
__init__.py	0	0	100%
permutation.py	22	1	95%	37
choice_learn/data
__init__.py	3	0	100%
choice_dataset.py	647	33	95%	198, 250, 283, 421, 463–464, 589, 724, 738, 840, 842, 937, 957–961, 1140, 1159–1161, 1179–1181, 1209, 1214, 1223, 1240, 1281, 1293, 1307, 1346, 1361, 1366, 1395, 1408, 1443–1444
indexer.py	239	23	90%	20, 31, 45, 60–67, 202–204, 219–230, 265, 291, 577
storage.py	161	6	96%	22, 33, 51, 56, 61, 71
store.py	72	72	0%	3–275
choice_learn/datasets
__init__.py	4	0	100%
base.py	393	5	99%	42–43, 153–154, 714
expedia.py	102	83	19%	37–301
tafeng.py	49	0	100%
choice_learn/datasets/data
__init__.py	0	0	100%
choice_learn/models
__init__.py	14	2	86%	15–16
base_model.py	262	13	95%	144, 186, 283, 302, 342, 349, 378, 397, 428–429, 438–439, 540
baseline_models.py	49	0	100%
conditional_logit.py	269	26	90%	49, 52, 54, 85, 88, 91–95, 98–102, 136, 206, 212–216, 351, 388, 445, 520–526, 651, 685, 822, 826
halo_mnl.py	124	2	98%	186, 374
latent_class_base_model.py	286	39	86%	55–61, 273–279, 288, 325–330, 497–500, 605, 624, 665–701, 715, 720, 751–752, 774–775, 869–870, 974
latent_class_mnl.py	62	6	90%	257–261, 296
learning_mnl.py	67	3	96%	157, 182, 188
nested_logit.py	291	12	96%	55, 77, 160, 269, 351, 484, 530, 600, 679, 848, 900, 904
reslogit.py	132	6	95%	285, 360, 369, 374, 382, 432
rumnet.py	236	3	99%	748–751, 982
simple_mnl.py	139	6	96%	167, 275, 347, 355, 357, 359
tastenet.py	94	3	97%	142, 180, 188
choice_learn/toolbox
__init__.py	0	0	100%
assortment_optimizer.py	27	6	78%	28–30, 93–95, 160–162
gurobi_opt.py	238	238	0%	3–675
or_tools_opt.py	230	11	95%	103, 107, 296–305, 315, 319, 607, 611
TOTAL	5181	740	86%

Tests	Skipped	Failures	Errors	Time
210	0 💤	0 ❌	0 🔥	7m 11s ⏱️

github-actions · 2025-09-08T15:17:04Z

Coverage Report for Python 3.11

File	Stmts	Miss	Cover	Missing
choice_learn
__init__.py	2	0	100%
tf_ops.py	62	1	98%	283
choice_learn/basket_models
__init__.py	4	0	100%
alea_carta.py	136	21	85%	84–88, 90–94, 96–100, 104, 107, 129, 157, 418–443
base_basket_model.py	211	17	92%	110–111, 122, 140, 183, 252, 353, 458, 555–557, 644, 724, 766–767, 867–868
basic_attention_model.py	78	4	95%	408, 411, 417, 424
shopper.py	171	7	96%	130, 159, 325, 345, 360, 363, 377
choice_learn/basket_models/data
__init__.py	2	0	100%
basket_dataset.py	137	7	95%	71–74, 369, 534, 573
preprocessing.py	94	78	17%	43–45, 128–364
synthetic_dataset.py	72	6	92%	54, 158–163, 203
choice_learn/basket_models/utils
__init__.py	0	0	100%
permutation.py	22	1	95%	37
choice_learn/data
__init__.py	3	0	100%
choice_dataset.py	647	33	95%	198, 250, 283, 421, 463–464, 589, 724, 738, 840, 842, 937, 957–961, 1140, 1159–1161, 1179–1181, 1209, 1214, 1223, 1240, 1281, 1293, 1307, 1346, 1361, 1366, 1395, 1408, 1443–1444
indexer.py	239	23	90%	20, 31, 45, 60–67, 202–204, 219–230, 265, 291, 577
storage.py	161	6	96%	22, 33, 51, 56, 61, 71
store.py	72	72	0%	3–275
choice_learn/datasets
__init__.py	4	0	100%
base.py	393	5	99%	42–43, 153–154, 714
expedia.py	102	83	19%	37–301
tafeng.py	49	0	100%
choice_learn/datasets/data
__init__.py	0	0	100%
choice_learn/models
__init__.py	14	2	86%	15–16
base_model.py	262	13	95%	144, 186, 283, 302, 342, 349, 378, 397, 428–429, 438–439, 540
baseline_models.py	49	0	100%
conditional_logit.py	269	26	90%	49, 52, 54, 85, 88, 91–95, 98–102, 136, 206, 212–216, 351, 388, 445, 520–526, 651, 685, 822, 826
halo_mnl.py	124	18	85%	186, 341, 360, 364–380
latent_class_base_model.py	286	39	86%	55–61, 273–279, 288, 325–330, 497–500, 605, 624, 665–701, 715, 720, 751–752, 774–775, 869–870, 974
latent_class_mnl.py	62	6	90%	257–261, 296
learning_mnl.py	67	3	96%	157, 182, 188
nested_logit.py	291	12	96%	55, 77, 160, 269, 351, 484, 530, 600, 679, 848, 900, 904
reslogit.py	132	6	95%	285, 360, 369, 374, 382, 432
rumnet.py	236	3	99%	748–751, 982
simple_mnl.py	139	6	96%	167, 275, 347, 355, 357, 359
tastenet.py	94	3	97%	142, 180, 188
choice_learn/toolbox
__init__.py	0	0	100%
assortment_optimizer.py	27	6	78%	28–30, 93–95, 160–162
gurobi_opt.py	238	238	0%	3–675
or_tools_opt.py	230	11	95%	103, 107, 296–305, 315, 319, 607, 611
TOTAL	5181	756	85%

Tests	Skipped	Failures	Errors	Time
210	0 💤	1 ❌	0 🔥	7m 42s ⏱️

github-actions · 2025-09-08T15:17:05Z

Coverage Report for Python 3.12

File	Stmts	Miss	Cover	Missing
choice_learn
__init__.py	2	0	100%
tf_ops.py	62	1	98%	283
choice_learn/basket_models
__init__.py	4	0	100%
alea_carta.py	136	21	85%	84–88, 90–94, 96–100, 104, 107, 129, 157, 418–443
base_basket_model.py	211	17	92%	110–111, 122, 140, 183, 252, 353, 458, 555–557, 644, 724, 766–767, 867–868
basic_attention_model.py	78	4	95%	408, 411, 417, 424
shopper.py	171	7	96%	130, 159, 325, 345, 360, 363, 377
choice_learn/basket_models/data
__init__.py	2	0	100%
basket_dataset.py	137	7	95%	71–74, 369, 534, 573
preprocessing.py	94	78	17%	43–45, 128–364
synthetic_dataset.py	72	6	92%	54, 158–163, 203
choice_learn/basket_models/utils
__init__.py	0	0	100%
permutation.py	22	1	95%	37
choice_learn/data
__init__.py	3	0	100%
choice_dataset.py	647	33	95%	198, 250, 283, 421, 463–464, 589, 724, 738, 840, 842, 937, 957–961, 1140, 1159–1161, 1179–1181, 1209, 1214, 1223, 1240, 1281, 1293, 1307, 1346, 1361, 1366, 1395, 1408, 1443–1444
indexer.py	239	23	90%	20, 31, 45, 60–67, 202–204, 219–230, 265, 291, 577
storage.py	161	6	96%	22, 33, 51, 56, 61, 71
store.py	72	72	0%	3–275
choice_learn/datasets
__init__.py	4	0	100%
base.py	393	5	99%	42–43, 153–154, 714
expedia.py	102	83	19%	37–301
tafeng.py	49	0	100%
choice_learn/datasets/data
__init__.py	0	0	100%
choice_learn/models
__init__.py	14	2	86%	15–16
base_model.py	262	13	95%	144, 186, 283, 302, 342, 349, 378, 397, 428–429, 438–439, 540
baseline_models.py	49	0	100%
conditional_logit.py	269	26	90%	49, 52, 54, 85, 88, 91–95, 98–102, 136, 206, 212–216, 351, 388, 445, 520–526, 651, 685, 822, 826
halo_mnl.py	124	18	85%	153, 172, 176–192, 374
latent_class_base_model.py	286	39	86%	55–61, 273–279, 288, 325–330, 497–500, 605, 624, 665–701, 715, 720, 751–752, 774–775, 869–870, 974
latent_class_mnl.py	62	6	90%	257–261, 296
learning_mnl.py	67	3	96%	157, 182, 188
nested_logit.py	291	12	96%	55, 77, 160, 269, 351, 484, 530, 600, 679, 848, 900, 904
reslogit.py	132	6	95%	285, 360, 369, 374, 382, 432
rumnet.py	236	3	99%	748–751, 982
simple_mnl.py	139	6	96%	167, 275, 347, 355, 357, 359
tastenet.py	94	3	97%	142, 180, 188
choice_learn/toolbox
__init__.py	0	0	100%
assortment_optimizer.py	27	6	78%	28–30, 93–95, 160–162
gurobi_opt.py	238	238	0%	3–675
or_tools_opt.py	230	11	95%	103, 107, 296–305, 315, 319, 607, 611
TOTAL	5181	756	85%

Tests	Skipped	Failures	Errors	Time
210	0 💤	1 ❌	0 🔥	8m 40s ⏱️

Update README.md

cb948cf

EmmanuelMalherbe requested a review from VincentAuriau as a code owner September 8, 2025 15:07

gemini-code-assist Bot reviewed Sep 8, 2025

View reviewed changes

VincentAuriau added 14 commits September 8, 2025 23:49

onging enhancements

c6f6df3

with the png...

fb4b4a2

add: finished new tables format

ac9f897

modif proposition

f7e73e3

polish

e869b7b

remove useless dir

d29c4f9

edit table

e4caf54

small modifs

e1a2506

fix links

b7d42f5

typo fix + TripDataset'

0555d57

small modifs

6526f02

enhance papers presentation

1ef5d8a

test

b681222

finlized modifications

0961bc8

VincentAuriau approved these changes Sep 14, 2025

View reviewed changes

VincentAuriau merged commit f275ddd into main Sep 14, 2025
8 checks passed

VincentAuriau deleted the EmmanuelMalherbe-readme-citation branch September 14, 2025 17:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update README.md#263

Update README.md#263
VincentAuriau merged 15 commits intomainfrom
EmmanuelMalherbe-readme-citation

EmmanuelMalherbe commented Sep 8, 2025 •

edited by VincentAuriau

Loading

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

gemini-code-assist Bot Sep 8, 2025

Uh oh!

github-actions Bot commented Sep 8, 2025 •

edited

Loading

Uh oh!

github-actions Bot commented Sep 8, 2025 •

edited

Loading

Uh oh!

github-actions Bot commented Sep 8, 2025 •

edited

Loading

Uh oh!

github-actions Bot commented Sep 8, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

EmmanuelMalherbe commented Sep 8, 2025 • edited by VincentAuriau Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist Bot Sep 8, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

EmmanuelMalherbe commented Sep 8, 2025 •

edited by VincentAuriau

Loading

github-actions Bot commented Sep 8, 2025 •

edited

Loading

github-actions Bot commented Sep 8, 2025 •

edited

Loading

github-actions Bot commented Sep 8, 2025 •

edited

Loading

github-actions Bot commented Sep 8, 2025 •

edited

Loading