Add EFGs from Shoham and Leyton-Brown (2008)

[wyz2368]

Tips for cleaning old docs:

To clean up old build, I run:

git clean -fdX catalog/img doc/catalog_table.rst

Then

python build_support/catalog/update.py --build

[rahulsavani]

This looks good at a glance but to properly review it, please first:

• merge in master to your fork so that the entry ShoLeyB08 is in the bibtex
• please update build_support/catalog/catalog_hierarchy.yaml as per the instructions at at https://gambitproject.readthedocs.io/en/latest/developer.catalog.html#updating-catalog, where the latest is important in many cases.

[rahulsavani]

Three things:

1. Citations are empty

The problem is the missing ref ([] instead of [ShoLeyB08]). I am not sure of the reason but one immediate thing I noticed is that the category is missing in the bibitem. Compare the following two, where the second has a category of textbooks:

@book{ShoLeyB08,
title={Multiagent systems: Algorithmic, game-theoretic, and logical foundations},
author={Shoham, Yoav and Leyton-Brown, Kevin},
year={2008},
publisher={Cambridge University Press}
}

with

@book{vS22,
author = {von Stengel, B.},
title = {Game Theory Basics},
publisher = {Cambridge University Press},
year = {2022},
category = {textbooks}
}

Hopefully the actual citation will appear when you add the category -- in any case, we want to make sure the final entry looks good before submitting the PR, which it didn't in this case.

2. Names inconsistent with existing entries

Please use naming that is totally consistent with what is already in the catalog. So fig5_1.efg instead of MAS_Fig5_1.efg (the MAS is anyway redundant -- the slug aleady mentions this, and the file contents give the citation, so not need for an extra indicator in the filename given that it's in the folder name).

3. Explicit .ef files

You have included .ef files in the PR. That might be fine, but I wanted to make sure these are not just the ones created by draw_tree anyway -- generally we are not adding .ef files unless they significantly differ from what we can create with draw_tree, e.g., if you did some manual edits to the .ef. If there are manual edits, it's fine to keep these, otherwise, let's remove them from the PR like for most other books/papers where entries are just the .efg.

Please request a re-review when appropriate, so that I know you are happy with it from your side.

[rahulsavani]

@wyz2368 As discussed, please add "__Original_Layout.ef" versions for the MAS book, and, ideally also for:

• fig 6 of von Stengel and Forges (2008); and
• the games from Bonnano (2018)

We will still have the "Default" ones created by draw_tree.

[wyz2368]

Hi @edwardchalstrey1, I tried to fix the issue of remembering old files. Your previous solution of using -e installation may fail in some cases. For example, if someone installs without -e first, then the issue still exists even with an installation with -e later.

I added a helper function to build_support/catelog/update.py to make sure the build following the latest information in catelog. Then this issue can be resolved on my end.

To clean up old build, I run:

git clean -fdX catalog/img doc/catalog_table.rst

Then

python build_support/catalog/update.py --build

Please help check if this address the issues you encountered earlier and if we need to update the guidance.

[edwardchalstrey1]

Hi @edwardchalstrey1, I tried to fix the issue of remembering old files. Your previous solution of using -e installation may fail in some cases. For example, if someone installs without -e first, then the issue still exists even with an installation with -e later.

I added a helper function to build_support/catelog/update.py to make sure the build following the latest information in catelog. Then this issue can be resolved on my end.

To clean up old build, I run:

git clean -fdX catalog/img doc/catalog_table.rst

Then

python build_support/catalog/update.py --build

Please help check if this address the issues you encountered earlier and if we need to update the guidance.

I'll test this now, also will make some small adjustments to the draw_tree settings for some of these games

[edwardchalstrey1]

Hi @wyz2368 I made some changes but since I can't edit this branch I opened a PR to it: wyz2368#2

If you merge it the changes will show up on this PR. Basically I have tweaked the settings for some of the games to avoid overlapping labels etc. Once you merge it you'll be able to see what I have done when the docs build.

As for this:

To clean up old build, I run:

git clean -fdX catalog/img doc/catalog_table.rst

Then

python build_support/catalog/update.py --build

I think this is a useful tip to add to the developer docs catalog page, do you want to add it there at a position that makes sense to you?

Also I suggest to update the top comment of this PR for clarity :)

[wyz2368]

@edwardchalstrey1 We can add the tip to the following part.

Btw, some checks failed after I merged your PR. I am a little bit confused what happened. Can you help to fix this? Thanks.

[edwardchalstrey1]

@wyz2368 sorry I got the draw_tree version wrong, that should be fixed now

[edwardchalstrey1]

@wyz2368 you can see my changes to the styling of games now: https://gambitproject--936.org.readthedocs.build/en/936/catalog.html#catalog

Also, I just made a PR which includes a tip with your line for cleaning up an old build here: #948 - this also explains a bit better how/when to add custom EF layouts and also how to quickly adjust a layout with DrawTree GUI

[rahulsavani]

This is looking good except for one thing:

@wyz2368 We said we would include all the "__Original_Layout" versions, no? Can you add those ones that looks like the originals, then we will have both the draw_tree version and that other "original layout" versions for all of these?

[wyz2368]

@rahulsavani Sorry for the delay. I got something urgent this week. My grandma broke her bones. I will do it early next week.

[rahulsavani]

@rahulsavani Sorry for the delay. I got something urgent this week. My grandma broke her bones. I will do it early next week.

No rush. I guess it was Ed that requested my review on this, not you.

Please just re-request a review from me when the work is done.

All the best to your grandma.