feat(docs): Create community datasets docs page#314
feat(docs): Create community datasets docs page#314younik merged 11 commits intoFarama-Foundation:mainfrom
Conversation
younik
left a comment
There was a problem hiding this comment.
Thanks for this, it looks good!
One important change: we should also generate the dataset page, and clicking on the card should open it (instead of the hugging face link as it is now).
You can reuse the function in this file:
https://github.com/Farama-Foundation/Minari/blob/main/docs/_scripts/gen_dataset_md.py
docs/_scripts/gen_community.py
Outdated
|
|
||
| content += ".. raw:: html\n\n" | ||
| content += " </div>\n\n" |
There was a problem hiding this comment.
it would be nice to add an extra "card", saying "Add your dataset here", that, if clicked, will point you to the README to add the dataset
docs/_scripts/gen_community.py
Outdated
| description = metadata.get("description", "") | ||
|
|
||
| # Generate page content with custom title | ||
| content = "---\nautogenerated:\n" | ||
| content += f"title: {display_name}\n" | ||
| content += "---\n\n" |
There was a problem hiding this comment.
and finally, from here to bottom, I think we should reuse the code in gen_dataset_md so dataset groups (even if nested) are handled correctly. You may need to refactor main() to use a customizable remote entry point, like hf://user/dataset instead of using our remote_datasets
Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Creates the community datasets page in the docs website. Requires adding PyYAML as a requirement.
Type of change
Screenshots
Checklist:
pre-commitchecks withpre-commit run --all-files(seeCONTRIBUTING.mdinstructions to set it up)pytest -vand no errors are present.pytest -vhas generated that are related to my code to the best of my knowledge.