Skip to main content

A reinforcement learning framework

Project description

SpyRL

SpyRL is a reinforcement learning (RL) framework that provides commonly used library, so you will write less code. For example, it automatically creates a learning graph for every learning session.

Installation

Use the package manager pip to install SpyRL.

pip install spyrl

Usage

import gym
import sys
sys.path.insert(0, "../spyrl")
from spyrl.activity.learning import Learning
from spyrl.activity.activity_config import ActivityConfig
from spyrl.listener.impl.basic_functions import BasicFunctions
from spyrl.agent_builder.impl.actor_critic_traces_agent_builder import ActorCriticTracesAgentBuilder
from example.cartpole.helper.cartpole_discretiser import CartpoleDiscretiser
from example.cartpole.helper.env_wrapper import GymEnvWrapper

if __name__ == '__main__':
    env = gym.make('CartPole-v0')
    num_actions = env.action_space.n
    config = ActivityConfig(num_episodes=1000, out_path='result/cartpole/test1/')
    agent_builder = ActorCriticTracesAgentBuilder(num_actions, discretiser=CartpoleDiscretiser())
    learning = Learning(listener=BasicFunctions(render=False))
    learning.learn(env, agent_builder, config)

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Citation

To cite this repository in publications:

@misc{spyrl,
  author = {Kurniawan, Budi and Vamplew, Peter and Papasimeon, Michael and Dazeley, Richard and Foale, Cameron},
  title = {SpyRL Framework},
  year = {2021},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/budi-kurniawan/spyrl}},
}

License

...

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

spyrl-0.0.1.tar.gz (27.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

spyrl-0.0.1-py3-none-any.whl (64.6 kB view details)

Uploaded Python 3

File details

Details for the file spyrl-0.0.1.tar.gz.

File metadata

  • Download URL: spyrl-0.0.1.tar.gz
  • Upload date:
  • Size: 27.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.26.0 CPython/3.7.0

File hashes

Hashes for spyrl-0.0.1.tar.gz
Algorithm Hash digest
SHA256 ce3c9fa8ddf9c20cd08a693719e72df5f39b1c85ff2935533cf7f471b208463e
MD5 1b8cb3f696a103cdfab72f97720575a2
BLAKE2b-256 92e680722a1b85ed745e76d96e8c85ad2e67d458e481cb56dd09bad649cf2d3b

See more details on using hashes here.

File details

Details for the file spyrl-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: spyrl-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 64.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.26.0 CPython/3.7.0

File hashes

Hashes for spyrl-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f3aae77986f5024899063c4b8d5e4c0ed6ecbca1ebda75a3f3119c83c50ce9d2
MD5 60793ac8e3bc850ff1fcbeed892618e0
BLAKE2b-256 2169ebfd3151e8201f197336aab6fadbe981e21f0192bd4cf0507247a131de7e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page