Metadata-Version: 2.1
Name: reinforcement
Version: 1.2.0
Summary: A reinforcement learning module
Home-page: https://github.com/SwamyDev/reinforcement
Author: Bernhard Raml
Author-email: pypi-reinforcment@googlegroups.com
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/SwamyDev/reinforcement/issues
Project-URL: Source, https://github.com/SwamyDev/reinforcement/
Description: [![Build Status](https://travis-ci.org/SwamyDev/reinforcement.svg?branch=master)](https://travis-ci.org/SwamyDev/reinforcement) [![Coverage Status](https://coveralls.io/repos/github/SwamyDev/reinforcement/badge.svg?branch=master)](https://coveralls.io/github/SwamyDev/reinforcement?branch=master) [![PyPI version](https://badge.fury.io/py/reinforcement.svg)](https://badge.fury.io/py/reinforcement)
        
        # Reinforcement
        The reinforcement package aims to provide simple implementations for basic reinforcement learning algorithms, using Test Driven Development and other principles of Software Engineering in an attempt to minimize defects and improve reproducibility. 
        
        ## Installation
        The library can be installed using pip:
        ```bash
        pip install reinforcement
        ```
        
        ## Example Implementation
        This section demonstrates how to implement a REINFORCE agent and benchmark it on the 'CartPole' gym environment.
        
        You can find the full implementation in [examples/reinforce.py](example/reinforce.py). The [example folder](example/) also contains some additional utility classes and functions that are used in the implementation.
        
        [embedmd]:# (example/reinforce.py python /def run_reinforce/ /env.close\(\)/)
        ```python
        def run_reinforce(config):
            reporter, env, rewards = Reporter(config), gym.make('CartPole-v0'), []
            with tf1.Session() as session:
                agent = _make_agent(config, session, env)
                for episode in range(1, config.episodes + 1):
                    reward = _run_episode(env, episode, agent, reporter)
                    rewards.append(reward)
                    if reporter.should_log(episode):
                        logger.info(reporter.report(episode, rewards))
            env.close()
        ```
        This is the main function setting up the boiler plate code. It creates the tensorflow session, logs the progress, and creats the agent. The `Reporter` class is just a helper to make logging at a certain frequency more convenient
        
        [embedmd]:# (example/reinforce.py python /def _make_agent/ /return BatchAgent\(alg\)/)
        ```python
        def _make_agent(config, session, env):
            p = ParameterizedPolicy(session, env.observation_space.shape[0], env.action_space.n, NoLog(), config.lr_policy)
            b = ValueBaseline(session, env.observation_space.shape[0], NoLog(), config.lr_baseline)
            alg = Reinforce(p, config.gamma, b, config.num_trajectories)
            return BatchAgent(alg)
        ```
        
        The factory function `_make_agent` creates the REINFORCE agent object. It uses a parameterized policy and baseline to learn and estimate proper actions. In this case, both parameterizations are straightforward artificial neural networks with no hidden layer. Both have the same input layer, but the output layer of the policy is a softmax function, whereas the baseline outputs a single linear value. The `BatchAgent` type records trajectories (states, actions, rewards) which are then used to optimize the policy and the baseline. The `NoLog` class is a Null-Object implementing the TensorBoard `FileWriter` interface.
        
        [embedmd]:# (example/reinforce.py python /def _run_episode/ /return reward/)
        ```python
        def _run_episode(env, episode, agent, report):
            obs = env.reset()
            done, reward = False, 0
            while not done:
                if report.should_render(episode):
                    env.render()
                obs, r, done, _ = env.step(agent.next_action(obs))
                agent.signal(r)
                reward += r
        
            agent.train()
            return reward
        ```
        
        This function performs a run through a single episode of the environment. Observations of the environment are passed to the agent's `next_action` interface function. The resulting estimated actions are passed again to the environment, leading to the next observation and a reward signal. The agent is then trained at the end of the episode because we want to train it on whole trajectories. It also contains a call to `env.render()` to visualize some runs. 
        
        ## Running an Example
        Running the REINFORCE agent example with default settings:
        ```bash
        python example/reinforce.py
        ```
        
        After a few 1000 episodes it should get very close to the highest achievable reward:
        ```
        ...
        INFO:__main__:Episode 2800: reward=200.0; mean reward of last 100 episodes: 199.71
        INFO:__main__:Episode 2900: reward=200.0; mean reward of last 100 episodes: 199.36
        INFO:__main__:Episode 3000: reward=200.0; mean reward of last 100 episodes: 198.09
        ```
        
Keywords: AI reinforcement learning
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: tf_cpu
Provides-Extra: tf_gpu
