Kinds-of-Intelligence-CFI / animal-ai

Animal-AI supports interdisciplinary research to help better understand human, animal, and artificial cognition.
https://sites.google.com/csah.cam.ac.uk/animalai/
Apache License 2.0
59 stars 9 forks source link

Add documentation for multi-arena episodes #51

Closed benaslater closed 7 months ago

benaslater commented 7 months ago

Proposed change(s)

This change adds a bit of documentation for the multi-episode arenas feature I've been working on. Arguably we should save this until that feature is merged an released, but getting the documentation PR done so we don't forget it.

Types of change(s)

Checklist

alhasacademy96 commented 7 months ago

Looks great Ben :)

Q: have you updated the other sections of the docs, where applicable, such as CHANGELOG.MD? For the sake of not forgetting any docs to update, perhaps it's better to update all other docs in this PR?

@benaslater

benaslater commented 7 months ago

Looks great Ben :)

Q: have you updated the other sections of the docs, where applicable, such as CHANGELOG.MD? For the sake of not forgetting any docs to update, perhaps it's better to update all other docs in this PR?

@benaslater

Sorry, I forgot about CHANGELOG.md. I can make a revision to this to update it - are there any other files in the docs you think would need updating?

alhasacademy96 commented 7 months ago

Perhaps you could update the changelog as a draft or remind me when the next build is to be released so I add your changes to the log, but for now, it's not important. I just wanted to ask if you considered the changelog.md in this PR.

I think as a general feedback you should aim to push the tech PR first and then push the docs on the docs, so its still fresh in your mind and you don't have to go back to the docs PR if changes are made in the tech PR. :)

notion-workspace[bot] commented 7 months ago

Multi-Arena Episodes

notion-workspace[bot] commented 7 months ago

Multi-Arena Episodes