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.

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

Env tutorial #305

Open
wants to merge 9 commits into
base: dev
Choose a base branch
from
Open

Env tutorial #305

wants to merge 9 commits into from

Conversation

mrsamsami
Copy link

"Environments" tutorial added to notebooks directory.

@mrsamsami mrsamsami added documentation Improvements or additions to documentation environment labels Nov 8, 2022
notebooks/env.ipynb Outdated Show resolved Hide resolved
notebooks/env.ipynb Outdated Show resolved Hide resolved
notebooks/env.ipynb Outdated Show resolved Hide resolved
notebooks/env.ipynb Outdated Show resolved Hide resolved
notebooks/env.ipynb Outdated Show resolved Hide resolved
notebooks/env.ipynb Outdated Show resolved Hide resolved
notebooks/env.ipynb Outdated Show resolved Hide resolved
notebooks/env.ipynb Outdated Show resolved Hide resolved
@mrsamsami mrsamsami requested a review from alirahkay January 12, 2023 22:59
Copy link
Collaborator

@alirahkay alirahkay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@mrsamsami mrsamsami changed the title Add env tutorial Env tutorial Jan 18, 2023
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

notebooks/env.ipynb Outdated Show resolved Hide resolved
notebooks/env.ipynb Outdated Show resolved Hide resolved
notebooks/env.ipynb Outdated Show resolved Hide resolved
@@ -0,0 +1,628 @@
{
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line #5.    !pip install RLHive['gym_minigrid']

This should be a separate PR, but it should probably be merged before this one. gym_minigrid is now just minigrid, and it's available as part of the Farama Foundation org. If you could update this tutorial to reflect those changes, that would be great.


Reply via ReviewNB

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So should I wait until the new PR is merged? Or I should install by directly installing Minigrid by running pip install minigrid?

notebooks/env.ipynb Outdated Show resolved Hide resolved
notebooks/env.ipynb Outdated Show resolved Hide resolved
notebooks/env.ipynb Outdated Show resolved Hide resolved
@@ -0,0 +1,628 @@
{
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to give an example of how to use this (eg configs). Also what to do when they have a custom environment that is a gym environment (eg registering with gym and then using hive).


Reply via ReviewNB

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if I understand your point here. What exactly do you mean by "example of how to use this"? We'll use the environment we've created in the following subsections. If you're only talking about custom environments and registering them, don't you think moving them up would make the tutorial a bit confusing?

@@ -0,0 +1,628 @@
{
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This explanation should be moved up to where the gym stuff is


Reply via ReviewNB

Copy link
Collaborator

@dapatil211 dapatil211 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I went through and left some comments. Also, there were a few typos some awkward language, if you could put the writing through ChatGPT or Grammarly, that might fix it.

@mrsamsami mrsamsami requested a review from dapatil211 January 25, 2023 15:46
Copy link
Collaborator

@dapatil211 dapatil211 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two comments/questions:

  1. Are you making the gym_minigrid -> minigrid changes?
  2. Can you move the gym registering stuff up higher to the explanation of where you first talk about the GymEnv? both pieces seem a bit out of place when not connected to each other.
    Other than that, i think its good.

@mrsamsami mrsamsami changed the base branch from dev to minigrid February 22, 2023 19:31
@mrsamsami mrsamsami requested a review from dapatil211 February 23, 2023 22:07
@mrsamsami mrsamsami changed the base branch from minigrid to clean-envs May 30, 2023 01:44
Base automatically changed from clean-envs to dev June 1, 2023 16:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation environment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants