diff --git a/README.md b/README.md index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..1b4da26e708fce0c253cad775c3222251f221cb7 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,10 @@ +This library contains headless versions of a number of commonly used tutoring system environments for training simulated students. + +To create an AI Gym environment for the Fraction Arithmetic tutor use the following commands: + +``` +import gym +import tutorenvs + +env = gym.make('FractionArith-v0') +``` diff --git a/TutorEnvs/__init__.py b/TutorEnvs/__init__.py index c3c689a98155bc9483300f20ec926bc8bd267e16..5e17f6febe15698f79e4bcd8f21f697f4464d6a9 100644 --- a/TutorEnvs/__init__.py +++ b/TutorEnvs/__init__.py @@ -1,6 +1,7 @@ from gym.envs.registration import register +from tutorenvs.fractions import FractionArithEnv register( - id='FractionArithEnv', - entry_point='TutorEnvs.envs:FractionArithEnv', + id='FractionArith-v0', + entry_point='tutorenvs:FractionArithEnv', ) diff --git a/TutorEnvs/fractions.py b/TutorEnvs/fractions.py index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..521c2fde9ed2e433011535fd30b9da371c538048 100644 --- a/TutorEnvs/fractions.py +++ b/TutorEnvs/fractions.py @@ -0,0 +1,18 @@ +import gym +from gym import error, spaces, utils +from gym.utils import seeding + +class FractionArithEnv(gym.Env): + metadata = {'render.modes': ['human']} + + def __init__(self): + pass + + def step(self, action): + pass + + def reset(self): + pass + + def render(self, mode='human', close=False): + pass