Unnecessary placeholder directory
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 252
- Forks
- 279
- Avg merge
- 8d 9h
- Merged PRs (30d)
- 2
Description
Background
In the mesa-examples repo, there is a non-existent subproject, "rl_models" (https://github.com/projectmesa/mesa-examples/blob/main/rl/rl_models) that returns a 404 Error page when navigating to it in the GitHub UI.
The directory was added in c4b4c75.
It seems to be a placeholder for the pre-weighted models hosted at (https://huggingface.co/projectmesa/rl_models/), which can be cloned into the current directory and used in the examples.
Discussion
Because navigating to the folder results in a 404 error, it could cause confusion or decrease confidence in the Mesa examples for folks newly approaching the repo.
The only code relying on this directory to be present is rl/Tutorials.ipynb, which should be updated with instructions to perform the git clone of the actual rl_models repo prior to running the notebook.
Recommendation
Remove the folder and update rl/Tutorials.ipynb and rl/example.py comments to reflect the actual location of the repo.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting the placeholder reference in rl/Tutorials.ipynb and the related comments in rl/example.py, then compare them with the rl_models repository on Hugging Face. Done means removing the unnecessary placeholder directory and updating both files with the actual repository location and clone instructions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100