Add El Farol Problem in mesa framework under example folder

[danielxu05]

No description provided.

[rht]

The requirements.txt seems to be empty.

[rht]

This if condition seems to be the same as the if condition in update_strategies of BarCustomer, if so, it'd be helpful to document that they are the same.

[rht]

What is the difference between the IBL and non IBL version? Would be informative to have this in the documentation.

[danielxu05]

Thanks rht! I have addressed all the comments you have and it should be ready to merge.

[rht]

Before this PR is merged, it would be good to squash all the commits into 1 commit, so that the main branch has a clean commit history.

[rht]

Bump. I think you should just ignore that particular ipynb from the Codespell CI. You can add the ignore path in

mesa/.github/workflows/python.yml

Line 81 in d346c48

skip: .*bootstrap.*,*.js,.*bootstrap-theme.css.map

.

Also, the .ipynb needs to be linted with Black.

[danielxu05]

Thanks @rht! I changed it and the commit should be ready to go.

[rht]

The diff for python.yml is too big. It seems that your code editor auto formatted it? Also, it should be just the El Farol ipynb, because we do need spell checking for other existing ipynb.

[danielxu05]

Yes. I think I used the code editor formatted it once. Should I change it back?

[rht]

Yeah, so that the diff is minimal, and GitHub doesn't flag the merge conflict.

[rht]

I ran the CI. It looks like el_farol.ipynb is not properly Blacked yet. Make sure to use the latest version of Black locally.

[danielxu05]

I used the lint-black to format el_farol.ipynb multiple times, but it still does not pass the test. Should I also exclude this for lint check ?

[danielxu05]

I ran the CI. It looks like el_farol.ipynb is not properly Blacked yet. Make sure to use the latest version of Black locally.

I am using the latest ones now.

[rht]

Are you on Python 3.9, or 3.11? The CI Black runs on 3.10.

[danielxu05]

I am on 3.8.3

[danielxu05]

I used python 3.10 and latest lint black to reformat it, but could not find any changes for the file.

[rht]

I'm on Python 3.10, Black 22.1.0, and running Black did indeed reformat the .ipynb. It's mostly removing the trailing "\n".

Another thing I noticed is that the .ipyn is 1.09 MB big. This will bog down the repo for sure. I think you should clear the cells of the computation result.
And, if the cells are cleared, you can reenable Codespell for the El Farol .ipynb, because most of the problems are caused by the image encoding strings.

[rht]

@danielxu05 I tried to clean up your PR, tried rebasing it on top of main, but the procedure is too complicated, due to lots of merge commits in this PR. I think, to save time, it is best to make a fresh branch from current Mesa main, and the manually put in the changes and then commit them as one git commit.

I recommend to add this in your ~/.gitconfig:

[pull]
    rebase = true

This way, every git pull will regenerate your commits to be on top of the base branch, i.e. main. No more merge commits.

[rht]

Superseded by projectmesa/mesa-examples#69.

[rht]

@harshmahesheka this is the original PR that has instance-based learning. My attempt to reproduce the result in the paper: projectmesa/mesa-examples#69 (comment). the RL version should be considered to be sound, as long as the equilibrium is the same as the ABM and IBL version.