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

Update readme #55

Merged
merged 6 commits into from
Sep 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 3 additions & 3 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ name: Tests

on:
push:
branches: [ main ]
branches: [main, development]
pull_request:
branches: [ main ]
branches: [main, development]

jobs:
build:
Expand All @@ -16,7 +16,7 @@ jobs:
strategy:
fail-fast: false
matrix:
python-version: ["3.8", "3.9", "3.10", "3.11"]
python-version: ["3.9", "3.10", "3.11", "3.12"]

steps:
- uses: actions/checkout@v3
Expand Down
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
# DeformableGym

This repository contains a collection of [gymnasium](https://github.com/Farama-Foundation/Gymnasium) environments built with [PyBullet](https://pybullet.org/). In these environments, the agent
needs to learn to grasp deformable object such as shoe insoles or pillows from sparse reward signals.
This repository contains a collection of [gymnasium](https://github.com/Farama-Foundation/Gymnasium) environments built with [PyBullet](https://pybullet.org/) and [MuJoCo](https://github.com/google-deepmind/mujoco).
In these environments, the agent needs to learn to grasp deformable 3D objects such as shoe insoles or pillows from sparse reward signals.

<p align="center">
<img src="doc/source/_static/defgym.svg"/>
Expand All @@ -23,6 +23,22 @@ After cloning the repository, it is recommended to install the library in editab
pip install -e .
```

## Available environments

| Environment Name | PyBullet | MuJoCo |
|---------------------------|:-------------------:|:------------------:|
| FloatingMiaGraspInsole | :heavy_check_mark: | :heavy_check_mark: |
| FloatingShadowGraspInsole | :heavy_check_mark: | :heavy_check_mark: |
| FloatingMiaGraspPillow | :heavy_check_mark: | :x: |
| FloatingShadowGraspInsole | :heavy_check_mark: | :x: |
| URMiaGraspInsole | :heavy_check_mark: | :x: |
| URShadowGraspInsole | :heavy_check_mark: | :x: |
| URMiaGraspPillow | :heavy_check_mark: | :x: |
| URShadowGraspPillow | :heavy_check_mark: | :x: |




### Known Issues

If you use conda, you may experience the error below:
Expand Down Expand Up @@ -100,7 +116,7 @@ pip install numpydoc sphinx sphinx-gallery sphinx-bootstrap-theme

If you wish to report bugs, please use the [issue tracker](https://github.com/dfki-ric/deformable_gym/issues). If you would like to contribute to DeformableGym, just open an issue or a
[pull request](https://github.com/dfki-ric/deformable_gym/pulls). The target branch for
merge requests is the development branch. The development branch will be merged to master for new releases. If you have
merge requests is the development branch. The development branch will be merged to main for new releases. If you have
questions about the software, you should ask them in the discussion section.

The recommended workflow to add a new feature, add documentation, or fix a bug is the following:
Expand Down Expand Up @@ -133,7 +149,7 @@ url = {https://deformable-workshop.github.io/icra2023/},

### Semantic Versioning

Semantic versioning must be used, that is, the major version number will be
[Semantic versioning](https://semver.org/) must be used, that is, the major version number will be
incremented when the API changes in a backwards incompatible way, the minor
version will be incremented when new functionality is added in a backwards
compatible manner, and the patch version is incremented for bugfixes,
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

setup(
name="deformable_gym",
version="0.4.0",
version="0.4.1",
maintainer="Melvin Laux",
maintainer_email="melvin.laux@uni-bremen.de",
description="Gym environments for grasping deformable objects",
Expand Down
Loading