Metadata-Version: 2.1
Name: learnrl
Version: 0.2.0
Summary: A package to learn about Reinforcement Learning
Home-page: https://github.com/MathisFederico/LearnRL
Author: Mathïs Fédérico
Author-email: mathfederico@gmail.com
License: UNKNOWN
Description: Welcome to LearnRL's documentation!
        ===================================
        
        About LearnRL
        -------------
        
        | LearnRL is a librairie to use and learn reinforcement learning.
        | Look how easy it is to use:
        
        .. code-block:: python
        
           import learnrl as rl
           from learnrl.environments import CrossesAndNoughtsEnv
           from learnrl.agents import StandardAgent
        
           env = CrossesAndNoughtsEnv()
           agent1 = StandardAgent(state_space=env.observation_space, action_space=env.action_space)
           agent2 = StandardAgent(state_space=env.observation_space, action_space=env.action_space)
        
           agents = [agent1, agent2]
           pg = rl.Playground(env, agents)
           pg.fit(50000, verbose=1)
        
        And boom you made two QLearning AIs training against each other on crosses and noughts !
        
        Features
        --------
        
        - Build highly configurable classic reinforcement learning agents in few lines of code
        - Train your Agents on any Gym environments
        - Use this API to create your own agents and environments (even multiplayer!) with great compatibility
        
        Installation
        ------------
        
        Install LearnRL by running::
        
           pip install learnrl
        
        Documentation
        -------------
        
        See the `latest complete documentation <https://learnrl.readthedocs.io/en/latest/>`_ for more details
        See the `developpement documentation <https://learnrl.readthedocs.io/en/dev/>`_ to see whats comming !
        
        Contribute
        ----------
        
        - `Issue Tracker <https://github.com/MathisFederico/LearnRL/issues>`_
        - `Projects <https://github.com/MathisFederico/LearnRL/projects>`_
        
        Support
        -------
        
        If you are having issues, please let me know at mathfederico@gmail.com
        
        License
        -------
        
        | The project is licensed under the GNU LGPLv3 license.
        | See LICENCE, COPYING and COPYING.LESSER for more details.
        
        .. |gym.Env| replace:: `environment <http://gym.openai.com/docs/#environments>`__
        .. |gym.Space| replace:: `space <http://gym.openai.com/docs/#spaces>`__
        .. |hash| replace:: `perfect hash functions <https://en.wikipedia.org/wiki/Perfect_hash_function>`__
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
