Skip to content

Unnecessary placeholder directory #263

Open
@jacklinke

Description

@jacklinke

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions