Farama-Foundation / stable-retro

Retro games for Reinforcement Learning

https://stable-retro.farama.org/

MIT License

163 stars 34 forks source link

Checklist for maturity #21

Open elliottower opened 1 year ago

elliottower commented 1 year ago

Checklist for Maturity

Copied from shimmy a few months ago, feel free to mark things as complete (I believe anyone can)

[ ] Support serialization via Pickle/EzPickle
[x] Fully deterministic
- As far as possible
[ ] Explicit Versioning
[x] Farama Notifications
[x] PyPI
[x] Full Package Description
[x] Deploy via GH Actions
[x] Website
[x] Linux and MacOS
[x] Precommit
[x] Typehinting
[x] Docstrings
[x] CI Testing
[x] Logo
[x] CoC (code of conduct)
[x] Gymnasium/PZ API
[x] Python Versions
[x] JKTerry and Mark as owners (pypi)
[x] TOTP (time based one time password)
[ ] Google Analytics
[x] License
[x] Sponsor this project button

MatPoliquin commented 1 year ago

@elliottower For "Support serialization via Pickle/EzPickle", you mean for serializing envs?

elliottower commented 1 year ago

@elliottower For "Support serialization via Pickle/EzPickle", you mean for serializing envs?

Yeah that’s for environments, but if it’s not possible here due to the complex emulators it’s probably not a big deal

MatPoliquin commented 1 year ago

@elliottower For explicit versioning, does shimmy plan to use that? looking at the repo it's still using the 3 number versions

elliottower commented 1 year ago

Oh sorry I think there’s a misunderstanding. Explicit versioning is for environments so like whenever you change the logic or anything that would make training go differently, change it from pong_v0 to v1, etc. For emulated envs like here I would think it would be more similar to shimmy having DmControlCompatibilityWrapperV0 for example, which gets updated when it loads the envs differently or would somehow otherwise affect training like rewards changed etc. See the farama.org project standards for more info

MatPoliquin commented 10 months ago

@elliottower So the checklist is progressing, there is two remaining items I have questions with: Google Analytics ID, where can I get the ID that Farama uses? For the Farama notifications, is there a guide on how to integrate that?

elliottower commented 10 months ago

Tagged you in a discord thread with the web dev guy manuel and a thread in all devs about farama notifications