CraftingWorld: a multitask environment for gym¶

Installation¶

Welcome to craftingworld! This guide will get you started.

To start using craftingworld, you’ll need to install gym-craftingworld

First install gym on your environment:
```
pip install gym
```
Now install craftingworld:
```
pip install gym-craftingworld
```
(Optional) If you want the ability to save renderings of each episode, you need to install pillow:
```
pip install pillow
```

General Information¶

Error

Unable to execute python code at gen_info.rst:5:

Environment version `v0` for `craftingworld` is deprecated. Please use the latest version `v3`.

Custom Environments¶

in order to create a custom environment, you need to import gym and gym_craftingworld, and then register your own version with the kwargs set as required

import gym
import gym_craftingworld

from gym.envs.registration import register
register(id='craftingworldMyCustomEnv-v3',
         entry_point='gym_craftingworld.envs:CraftingWorldEnvRay',
         kwargs={'stacking':True}
         )

env = gym.make('craftingworldMyCustomEnv-v3')

then just use the environment as usual.

further details about the init args are below:

Upcoming Features/Fixes¶

change the init specs to increase customisation (change number of objects to start with, ensure a minimum of 1 object of a specified type, etc.)
create tests for code coverage most important
integrate with multiworld for multitask RL

Contribute¶

If you find an issue or want to contribute to the code in any way, either contact DArcyL@cardiff.ac.uk or raise an issue/make a pull request on the github