search

minerllabs / minerl

MineRL Competition for Sample Efficient Reinforcement Learning - Python Package
http://minerl.io/docs/
Other
711 stars 153 forks source link

download: Update docs and assertions #551

Closed shwang closed 3 years ago

shwang commented 3 years ago

Updates download function documentation, in particular noting the experiment => environment change (sorry for this stealth change earlier), and noting which arguments are "internal" on which ones are external.

I also moved the important (public-facing) arguments in download() earlier in the argument list, and added some assertions

Broader question: Does it seem like the right idea to document the download function as a low-level function, and point people towards using the python -m minerl.data.download script instead?

pep8speaks commented 3 years ago

Hello @shwang! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! :beers:

Comment last updated at 2021-07-09 23:33:13 UTC