Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update custom env doc to match gym API #597

Merged
merged 5 commits into from
Dec 4, 2019
Merged

Update custom env doc to match gym API #597

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fc50aa9
Update to use new close API
jkterry1 Dec 3, 2019
7e86418
Update custom env documentation to reflect new gym close API
jkterry1 Dec 4, 2019
7aab147
Update changelog.rst
araffin Dec 4, 2019
8d625db
Clarifies what reset returns
jkterry1 Dec 4, 2019
fb8770f
Update changelog.rst
jkterry1 Dec 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/guide/custom_env.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,13 @@ That is to say, your environment must implement the following methods (and inher

def step(self, action):
...
return observation, reward, done, info
def reset(self):
...
def render(self, mode='human', close=False):
return observation # reward, done, info can't be included
def render(self, mode='human'):
...
def close (self):
...


Expand Down
4 changes: 3 additions & 1 deletion docs/misc/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ Documentation:
- Fix outdated source documentation for load_results
- Add PPO_CPP project (@Antymon)
- Add section on C++ portability of Tensorflow models (@Antymon)
- Update custom env documentation to reflect new gym API for the `close()` method (@justinkterry)
- Update custom env documentation to clarify what step and reset return (@justinkterry)

Release 2.8.0 (2019-09-29)
--------------------------
Expand Down Expand Up @@ -547,4 +549,4 @@ Thanks to @bjmuld @iambenzo @iandanforth @r7vme @brendenpetersen @huvar @abhiskk
@EliasHasle @mrakgr @Bleyddyn @antoine-galataud @junhyeokahn @AdamGleave @keshaviyengar @tperol
@XMaster96 @kantneel @Pastafarianist @GerardMaggiolino @PatrickWalter214 @yutingsz @sc420 @Aaahh @billtubbs
@Miffyli @dwiel @miguelrass @qxcv @jaberkow @eavelardev @ruifeng96150 @pedrohbtp @srivatsankrishnan @evilsocket
@MarvineGothic @jdossgollin @SyllogismRXS @rusu24edward @jbulow @Antymon @seheevic
@MarvineGothic @jdossgollin @SyllogismRXS @rusu24edward @jbulow @Antymon @seheevic @justinkterry