Skip to content

WebSocket client that consumes an API wrapping OpenAI Gym or gym-like environments such as Gym Retro or Unity ML-Agents.

License

Notifications You must be signed in to change notification settings

jscriptcoder/Gymie-Client

Repository files navigation

Gymie - Client


npmPyPI

WebSocket client that consumes an API wrapping OpenAI Gym or Gym-like environments such as Gym Retro or Unity ML-Agents. Currently the best server is its counterpart Gymie-Server 😉

Content of this document

Installation

Gymie-Client is available as a NPM package, and can installed as a dependency as usual:

$ npm install gymie 

You can also clone the repo and npm-link the library as follows, although there isn't really a good readon to do it this way, unless you wanna contribute to the library and test it locally.

$ git clone https://github.com/jscriptcoder/Gymie-Client Cloning into 'Gymie-Client'... ... $ cd Gymie-Client/ $ npm link [email protected] 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 

During the installation Gymie-Server will also be installed. It's important to note that Gymie-Server requires Python>=3.6, so I suggest to conda-create an environment with such version if it's not already installed... or upgrade Python to at least this version.

How to run the client (and server)

Gymie-Client communicates with a server through WebSockets. This server will provide Gymie with an API to access the underlying Python library to create and interact with an environment. As mentioned before, this client comes with its counterpart server. You can start the server from the command line:

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

Once the server is running, Gymie-Client can start interacting with it as follows:

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

Complete API documentation can be found here: Gymie-Client API(generated by TypeDoc)

In the previous section we already saw how to import gymie, connect to the server, instantiate an environment and call a few API methods. Let's go a bit more in detail with a complete example of a random agent interacting with an environment:

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 environment caseerrinstanceofNoConnected: break// There was a socket errorcaseerrinstanceofConnectionError: break// Server closed the connection. Code and reason comes in the messagecaseerrinstanceofConnectionClosed: break}}finally{gymie.close()}})()

Testing Gymie

All unit-tests live next to the code they're testing, under the extension src/*.test.ts. You can run all the tests by executing:

$ npm test 

License

MIT License - Copyright (c) 2020 Francisco Ramos

About

WebSocket client that consumes an API wrapping OpenAI Gym or gym-like environments such as Gym Retro or Unity ML-Agents.

Resources

License

Stars

Watchers

Forks

Packages

No packages published