Content of this document

Installation

$ npm install gymie

$ git clone https://github.com/jscriptcoder/Gymie-ClientCloning into 'Gymie-Client'......$ cd Gymie-Client/$ npm linkgymie@0.x.y preinstall /path/to/Gymie-Client...$ cd ~/path/to/project$ npm link gymie/path/to/project/node_modules/gymie -> /usr/local/lib/node_modules/gymie -> /path/to/Gymie-Client

How to run the client (and server)

$ python -m gymie --host 0.0.0.0 --port 5000(84581) wsgi starting up on http://0.0.0.0:5000

importGymiefrom'gymie'constgymie=newGymie()awaitgymie.connect('http://0.0.0.0:5000')// connects to the serverconstenv=awaitgymie.make('LunarLander-v2')// instantiates an environment// accesing the underlying Gym-like library.constspace=awaitenv.actionSpace()constinitialState=awaitenv.reset()constrandomAction=awaitenv.actionSample()

API and how to use it

importGymiefrom'gymie'import{Continuous,Discrete}from'gymie/Env'import{ConnectFailed,NoConnected,ConnectionError,ConnectionClosed}from'gymie/errors'constwsApi='http://0.0.0.0:5000/gym'constenvId='LunarLander-v2'const{ log}=console;(async()=>{constgymie=newGymie()try{// Connects to the serverawaitgymie.connect(wsApi)// Instantiates the environment, in this case it's got// a continuous state and discrete action space.constenv=awaitgymie.make<Continuous,Discrete>(envId)constspace=awaitenv.actionSpace()log('Action Space:',space)// => Action Space: { name: 'Discrete', n: number }constinitialState=awaitenv.reset()log('Initial State:\n',initialState)// => Initial State: number[]letstep=0lettotalReward=0// Running loop: runs an episode until `done = true`log('---- START episode ----')while(true){log(`\nStep:${++step}`)// Samples a random actionconstaction=awaitenv.actionSample()log('Action:',action)// => Action: number from [0..n)// Performs a step on the environment given the actionconst[nextState,reward,done,_]=awaitenv.step(action)log('Next State:\n',nextState)// => Next State: number[]log(`Reward:${reward}`)// => Next State: numbertotalReward+=rewardif(done){log('---- END episode ----')break}}log(`\nEpisode Reward:${totalReward}\n`)awaitenv.close()}catch(err){switch(true){// This could happen while trying to connect to the servercaseerrinstanceofConnectFailed:break// There is no connection and we try to instantiate an environmentcaseerrinstanceofNoConnected:break// There was a socket errorcaseerrinstanceofConnectionError:break// Server closed the connection. Code and reason comes in the messagecaseerrinstanceofConnectionClosed:break}}finally{gymie.close()}})()

Testing Gymie

$ npm test

License