Add documentation for multi-arena episodes #51
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
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? |
| @@ -557,6 +557,50 @@ We can observe that: | |||
| * Additionally, if we set `blackouts` to `[-20]`, the arena will blackout every 20 frames (because we placed the '-' indicating repeat). | |||
| * The blackout has no effect on any other aspect of the agent or the arena. For example, the agent will still be able to move around the arena, and the objects in the arena will still be visible to the agent. _RayCasting_ will still work. | |||
|
|
|||
| #### EXAMPLE 8 - Multi-Arena Episodes | |||
There was a problem hiding this comment.
Did you also update the TOC to add this new section?
There was a problem hiding this comment.
Potentially stupid question - what is TOC?
There was a problem hiding this comment.
table of contents in the md file :).
| !ArenaConfig | ||
| arenas: | ||
| 0: !Arena | ||
| t: 50 |
There was a problem hiding this comment.
note that "t" and "pass_mark" will be renamed to "timeLimit" and "passMark" respectively. This is for all AAI builds from v.4.1.0 and up.
For the sake of brevity, could you replace these to their newer names?
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? |
|
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. :) |
1 similar comment
added example yaml file demonstraing the feature ben has produced (mergeArenas).
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