ENH: Rm - small edits by VincentAuriau · Pull Request #288 · artefactory/choice-learn

VincentAuriau · 2025-11-25T15:44:13Z

No description provided.

for more information, see https://pre-commit.ci

gemini-code-assist · 2025-11-25T15:44:32Z

Summary of Changes

Hello @VincentAuriau, 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 primarily enhances the project's documentation and tutorial structure. It aims to make it easier for users to discover and navigate learning resources by adding new external tutorial links, improving internal tutorial references, and refining the documentation site's navigation. Additionally, minor formatting improvements were made to ensure consistency and readability within Jupyter notebooks.

Highlights

Documentation Enhancement: A new 'Medium tutorials' section has been added to the README.md, providing links to external articles, and the 'Citation' section title has been updated for clarity.
Tutorial Accessibility: The docs/tutorials.md file has been improved by correcting a typo and adding direct links to core introductory tutorials, making them easier to find.
Navigation Updates: The mkdocs.yaml configuration was modified to correct a tutorial file path and to introduce a new 'Utils' section for better organization of reference documentation.
Notebook Refinements: Minor formatting adjustments were applied to LaTeX equations in Jupyter notebooks (3_model_clogit.ipynb and nested_logit.ipynb) for improved readability, and kernel metadata was updated in 3_model_clogit.ipynb.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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 pull request includes several small edits, primarily improving documentation and formatting. I've identified a couple of minor issues: one is a broken link in docs/tutorials.md due to a typo, and the other is excessive blank lines in README.md. My review includes suggestions to fix these. The other changes, such as formatting in Jupyter notebooks and updates to mkdocs.yaml, look good.

gemini-code-assist · 2025-11-25T15:45:27Z

+
+- [Introduction](https://artefactory.github.io/choice-learn/notebooks/introduction/1_introductive_example/)
+- [Data Handling](https://artefactory.github.io/choice-learn/notebooks/introduction/2_data_handling/)
+- [Basket Data Handling](https://artefactory.github.io/choice-learn/notebooks/basket_models/basket_data.)


The URL for 'Basket Data Handling' appears to have a typo. It ends with a period (.) which will likely result in a broken link. Based on the other links, it should probably end with a /.

Suggested change

- [Basket Data Handling](https://artefactory.github.io/choice-learn/notebooks/basket_models/basket_data.)

- [Basket Data Handling](https://artefactory.github.io/choice-learn/notebooks/basket_models/basket_data/)

github-actions · 2025-11-25T15:54:14Z

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	144	22	85%	84–88, 90–94, 96–100, 104, 107, 129, 157, 304, 427–452
base_basket_model.py	229	21	91%	111–112, 123, 141, 184, 253, 353, 456, 553–555, 641, 721, 763–764, 827–830, 842, 878–879
basic_attention_model.py	87	4	95%	413, 416, 422, 429
shopper.py	182	9	95%	130, 159, 325, 345, 360, 363, 377, 487, 616
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
choice_learn/basket_models/datasets
__init__.py	3	0	100%
bakery.py	38	3	92%	47, 53, 61
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	649	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	241	23	90%	20, 31, 45, 60–67, 202–204, 219–230, 265, 291, 582
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	400	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	303	22	93%	144, 186, 283, 291, 297, 306, 346, 353, 382, 401, 432–433, 442–443, 544, 546, 562, 566, 568, 691–692, 865
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
choice_learn/utils
metrics.py	34	1	97%	74
TOTAL	5354	760	86%

Tests	Skipped	Failures	Errors	Time
216	0 💤	0 ❌	0 🔥	7m 3s ⏱️

github-actions · 2025-11-25T15:54:24Z

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	144	22	85%	84–88, 90–94, 96–100, 104, 107, 129, 157, 304, 427–452
base_basket_model.py	229	21	91%	111–112, 123, 141, 184, 253, 353, 456, 553–555, 641, 721, 763–764, 827–830, 842, 878–879
basic_attention_model.py	87	4	95%	413, 416, 422, 429
shopper.py	182	9	95%	130, 159, 325, 345, 360, 363, 377, 487, 616
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
choice_learn/basket_models/datasets
__init__.py	3	0	100%
bakery.py	38	3	92%	47, 51, 61
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	649	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	241	23	90%	20, 31, 45, 60–67, 202–204, 219–230, 265, 291, 582
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	400	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	303	21	93%	144, 186, 283, 291, 297, 306, 346, 353, 382, 401, 432–433, 442–443, 544, 546, 562, 566, 568, 691–692
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
choice_learn/utils
metrics.py	34	1	97%	74
TOTAL	5352	757	86%

Tests	Skipped	Failures	Errors	Time
216	0 💤	0 ❌	0 🔥	7m 8s ⏱️

github-actions · 2025-11-25T15:54:54Z

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	144	22	85%	84–88, 90–94, 96–100, 104, 107, 129, 157, 304, 427–452
base_basket_model.py	229	21	91%	111–112, 123, 141, 184, 253, 353, 456, 553–555, 641, 721, 763–764, 827–830, 842, 878–879
basic_attention_model.py	87	4	95%	413, 416, 422, 429
shopper.py	182	9	95%	130, 159, 325, 345, 360, 363, 377, 487, 616
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
choice_learn/basket_models/datasets
__init__.py	3	0	100%
bakery.py	38	3	92%	47, 51, 61
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	649	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	241	23	90%	20, 31, 45, 60–67, 202–204, 219–230, 265, 291, 582
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	400	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	303	21	93%	144, 186, 283, 291, 297, 306, 346, 353, 382, 401, 432–433, 442–443, 544, 546, 562, 566, 568, 691–692
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
choice_learn/utils
metrics.py	34	1	97%	74
TOTAL	5354	775	86%

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

github-actions · 2025-11-25T15:55:07Z

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	144	22	85%	84–88, 90–94, 96–100, 104, 107, 129, 157, 304, 427–452
base_basket_model.py	229	21	91%	111–112, 123, 141, 184, 253, 353, 456, 553–555, 641, 721, 763–764, 827–830, 842, 878–879
basic_attention_model.py	87	4	95%	413, 416, 422, 429
shopper.py	182	9	95%	130, 159, 325, 345, 360, 363, 377, 487, 616
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
choice_learn/basket_models/datasets
__init__.py	3	0	100%
bakery.py	38	3	92%	47, 51, 61
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	649	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	241	23	90%	20, 31, 45, 60–67, 202–204, 219–230, 265, 291, 582
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	400	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	303	21	93%	144, 186, 283, 291, 297, 306, 346, 353, 382, 401, 432–433, 442–443, 544, 546, 562, 566, 568, 691–692
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
choice_learn/utils
metrics.py	34	1	97%	74
TOTAL	5354	759	86%

Tests	Skipped	Failures	Errors	Time
216	0 💤	0 ❌	0 🔥	8m 0s ⏱️

VincentAuriau and others added 30 commits November 7, 2025 17:46

FIX: basket embedding averaged

f1ff74e

[pre-commit.ci] auto fixes from pre-commit.com hooks

c5fdc56

for more information, see https://pre-commit.ci

enh: method to get size

a5ec11c

merge

f7a257d

ADD: min size check

55081d9

ENH: proposition for evaluate with metrics as argument

26dacf4

[pre-commit.ci] auto fixes from pre-commit.com hooks

bb6ffd4

for more information, see https://pre-commit.ci

fix evaluate

7acff6f

[pre-commit.ci] auto fixes from pre-commit.com hooks

2555f9b

for more information, see https://pre-commit.ci

ADD: NLL metric

503856d

update base basket model with NLL metric'

10b3539

ADD: unit tests for NLL'

a4a5e55

lint & all

754e092

ADD: metrics

738fe80

small fixes in shape & all

aaa8f56

FIX: basket tests

0e9c25b

ADD: shape test in compute_batch_utility'

6169114

update & enhance models

2b589d7

enh and fix tests

a0aabd2

ENH: shopper

e9a2668

ENH: example notebook

37bf1e5

test follow latest signatures

17082f7

FIX: tests

170bfe2

FIX: final ? test

3f2b7dd

ADD: basketwise NLL

7d72e46

enh: notebook

29e5e52

cleaning

0f1f342

add: unit tests for metric w/ sample weight

5c47700

ADD: diverse stuff

ef7502b

Merge branch 'some-merge' into some-doc

92eae1e

ADD: link to Medium articles

a66918d

gemini-code-assist Bot reviewed Nov 25, 2025

View reviewed changes

Merge branch 'main' into add-med

bdbdf9f

VincentAuriau merged commit 7c7a68f into main Nov 25, 2025
8 checks passed

VincentAuriau deleted the add-med branch November 25, 2025 15:56

Navigation Menu

Uh oh!

ENH: Rm - small edits - #288

ENH: Rm - small edits#288
VincentAuriau merged 32 commits into
mainfrom
add-med

VincentAuriau commented Nov 25, 2025

Uh oh!

gemini-code-assist Bot commented Nov 25, 2025

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

gemini-code-assist Bot Nov 25, 2025

Uh oh!

github-actions Bot commented Nov 25, 2025

Uh oh!

github-actions Bot commented Nov 25, 2025

Uh oh!

github-actions Bot commented Nov 25, 2025

Uh oh!

github-actions Bot commented Nov 25, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	- [Basket Data Handling](https://artefactory.github.io/choice-learn/notebooks/basket_models/basket_data.)
	- [Basket Data Handling](https://artefactory.github.io/choice-learn/notebooks/basket_models/basket_data/)

Uh oh!

Conversation

VincentAuriau commented Nov 25, 2025

Uh oh!

gemini-code-assist Bot commented Nov 25, 2025

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 Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Nov 25, 2025

Uh oh!

github-actions Bot commented Nov 25, 2025

Uh oh!

github-actions Bot commented Nov 25, 2025

Uh oh!

github-actions Bot commented Nov 25, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant