-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from harisankar95/migrate-to-gymnasium
Migrate to gymnasium
- Loading branch information
Showing
27 changed files
with
1,040 additions
and
401 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # Installation | ||
|
|
||
| ## PyPI | ||
|
|
||
| Install the package from PyPI using pip: | ||
|
|
||
| ```bash | ||
| pip install voxelgym2D | ||
| ``` | ||
|
|
||
| ## GitHub | ||
|
|
||
| ```bash | ||
| pip install git+https://github.com/harisankar95/voxelgym2D.git | ||
| ``` | ||
|
|
||
| ## For development purpose use editable mode | ||
|
|
||
| To install the package in development mode, run the following command in the root directory of the repository: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/harisankar95/voxelgym2D.git ~/path/to/repo | ||
| cd ~/path/to/repo | ||
| pip install -e .[dev] | ||
|
|
||
| # to aditionally install stable_baselines 3 and pytorch (optional) | ||
| pip install -e .[dev,sb3] | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # Voxelgym2D | ||
|
|
||
| A gym environment for voxel/grid based reinforcement learning for path planning. | ||
|
|
||
| <div id="solution-table"> | ||
| <table> | ||
| <tr> | ||
| <td style="padding:10px"> | ||
| <img src="https://github.com/harisankar95/voxelgym2D/raw/main/resources/solution_1.gif" width="375"/> | ||
| </td> | ||
| <td style="padding:10px"> | ||
| <img src="https://github.com/harisankar95/voxelgym2D/raw/main/resources/solution_2.gif" width="375"/> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
| </div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # Examples | ||
|
|
||
| For usage examples with detailed descriptions take a look at the [examples](https://github.com/harisankar95/voxelgym2D/tree/main/examples/) folder. | ||
|
|
||
| ## Basic usage | ||
|
|
||
| ```python | ||
| import gymnasium as gym | ||
|
|
||
| env = gym.make("voxelgym2D:onestep-v0") | ||
| observation, info = env.reset(seed=123456) | ||
|
|
||
| done = False | ||
| while not done: | ||
| action = env.action_space.sample() # agent policy that uses the observation and info | ||
| observation, reward, terminated, truncated, info = env.step(action) | ||
|
|
||
| done = terminated or truncated | ||
| env.render() | ||
|
|
||
| env.close() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| /* Based on Stable Baselines 3 theme | ||
| * https://github.com/DLR-RM/stable-baselines3/ | ||
| * */ | ||
| :root { | ||
| --main-bg-color: #B6C8DB; | ||
| --link-color: #6DB59F; | ||
| } | ||
|
|
||
| /* Header fonts y */ | ||
| h1, | ||
| h2, | ||
| .rst-content .toctree-wrapper p.caption, | ||
| h3, | ||
| h4, | ||
| h5, | ||
| h6, | ||
| legend, | ||
| p.caption { | ||
| font-family: "Lato", "proxima-nova", "Helvetica Neue", Arial, sans-serif; | ||
| } | ||
|
|
||
|
|
||
| /* Docs background */ | ||
| .wy-side-nav-search { | ||
| background-color: var(--main-bg-color); | ||
| } | ||
|
|
||
| /* Mobile version */ | ||
| .wy-nav-top { | ||
| background-color: var(--main-bg-color); | ||
| } | ||
|
|
||
| /* Change link colors (except for the menu) */ | ||
| a { | ||
| color: var(--link-color); | ||
| } | ||
|
|
||
| a:hover { | ||
| color: #798EA9; | ||
| } | ||
|
|
||
| .wy-menu a { | ||
| color: #b3b3b3; | ||
| } | ||
|
|
||
| .wy-menu a:hover { | ||
| color: #b3b3b3; | ||
| } | ||
|
|
||
| a.icon.icon-home { | ||
| color: #b3b3b3; | ||
| } | ||
|
|
||
| .version { | ||
| color: var(--link-color) !important; | ||
| } | ||
|
|
||
|
|
||
| /* Make code blocks have a background */ | ||
| .codeblock, | ||
| pre.literal-block, | ||
| .rst-content .literal-block, | ||
| .rst-content pre.literal-block, | ||
| div[class^='highlight'] { | ||
| background: #FFFFFF; | ||
| ; | ||
| } | ||
|
|
||
| /* Change style of types in the docstrings .rst-content .field-list */ | ||
| .field-list .xref.py.docutils, | ||
| .field-list code.docutils, | ||
| .field-list .docutils.literal.notranslate { | ||
| border: None; | ||
| padding-left: 0; | ||
| padding-right: 0; | ||
| color: #404040; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| {%- if current_version %} | ||
| <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> | ||
| <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| <span class="fa fa-book"> Other Versions</span> | ||
| v: {{ current_version.name }} | ||
| <span class="fa fa-caret-down"></span> | ||
| </span> | ||
| <div class="rst-other-versions"> | ||
| {%- if versions.tags %} | ||
| <dl> | ||
| <dt>Tags</dt> | ||
| {%- for item in versions.tags %} | ||
| <dd><a href="{{ item.url }}">{{ item.name }}</a></dd> | ||
| {%- endfor %} | ||
| </dl> | ||
| {%- endif %} | ||
| {%- if versions.branches %} | ||
| <dl> | ||
| <dt>Branches</dt> | ||
| {%- for item in versions.branches %} | ||
| <dd><a href="{{ item.url }}">{{ item.name }}</a></dd> | ||
| {%- endfor %} | ||
| </dl> | ||
| {%- endif %} | ||
| </div> | ||
| </div> | ||
| {%- endif %} |
Oops, something went wrong.