Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/franckndame/drlkit
A High Level Python Deep Reinforcement Learning library. Great for beginners, prototyping and quickly comparing algorithms
https://github.com/franckndame/drlkit
comparing-algorithms deep-learning deep-reinforcement-learning gpu gym gym-environment machine-learning numpy python pytorch reinforcement-learning tensor tensorflow
Last synced: 1 day ago
JSON representation
A High Level Python Deep Reinforcement Learning library. Great for beginners, prototyping and quickly comparing algorithms
- Host: GitHub
- URL: https://github.com/franckndame/drlkit
- Owner: FranckNdame
- License: mit
- Created: 2019-12-04T13:34:13.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T03:17:31.000Z (almost 2 years ago)
- Last Synced: 2024-04-25T09:02:23.558Z (5 months ago)
- Topics: comparing-algorithms, deep-learning, deep-reinforcement-learning, gpu, gym, gym-environment, machine-learning, numpy, python, pytorch, reinforcement-learning, tensor, tensorflow
- Language: Python
- Size: 75.6 MB
- Stars: 32
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Security: SECURITY.md
Awesome Lists containing this project
README
--------------------------------------------------------------------------------
A High Level Python Deep Reinforcement Learning library.
Great for beginners, prototyping and quickly comparing algorithms
## Installation 📦
Install drlkit via pip
```python
pip install drlkit
```
## Usage 📖
**1.** Import the modules
```python
import numpy as np
from agents.TorchAgent import TorchAgent
from utils.plot import Plot
from environments.wrapper import EnvironmentWrapper
```
**2.** Initialize the environment and the agent
```python
ENV_NAME = "LunarLander-v2"
env = EnvironmentWrapper(ENV_NAME)
agent = TorchAgent(state_size=8, action_size=env.env.action_space.n, seed=0)
```
**3.** Train the agent
```python
# Train the agent
env.fit(agent, n_episodes=1000)
```
**4.** Plot the results (optional)
```python
# See the results
Plot.basic_plot(np.arange(len(env.scores)), env.scores, xlabel='Episode #', ylabel='Score')
```
**5.** Play 🎮
```python
# Play trained agent
env.play(num_episodes=10, trained=True)
```
# It is as simple as that! 🤯
--------------------------------------------------------------------------------
### Loading a model 🗃
```python
ENV_NAME = "LunarLander-v2"
env = EnvironmentWrapper(ENV_NAME)
agent = TorchAgent(state_size=8, action_size=env.env.action_space.n, seed=0)
env.load_model(agent, "./models/LunarLander-v2-4477.pth")
env.play(num_episodes=10)
```
### Play untrained agent
```python
env.play(num_episodes=10, trained=False)
```
### Play trained agent (4477 episodes, 3 hours)
```python
env.play(num_episodes=10, trained=True)
```
## Tested Environments ⛳️
| **Environment** |
| --------------------------- |
| LunarLander-v2 |
| CartPole-v1 |
| MountainCar-v0 |
## Implemented Algorithms 📈
`Done` = :heavy_check_mark: ||
`In Progress` = :heavy_minus_sign: ||
`Not done yet` = :x:
| **Algorithms** | **Status** | **Tested** |
| --------------------------- | --------------------------------- | --------------------------------- |
| DQN | :heavy_check_mark: (1) | :heavy_check_mark: |
| DDPG | :heavy_minus_sign: | :heavy_minus_sign: |
| PPO1 | :x: | :x: |
| PPO2 | :x: | :x: |
| A2C | :x: | :x: |
| SAC | :x: | :x: |
| TD3 | :x: | :x: |
## 👀 Next steps
* [x] Implement DQN
* [x] Test DQN
* [ ] Finish DDPG
* [ ] Implement PP01
* [ ] Improve documentation
## ❤️ Contributing
This is an open source project, so feel free to contribute. How?
- Open an [issue](https://github.com/FranckNdame/drlkit/issues/new).
- Send feedback via [email](mailto://[email protected]).
- Propose your own fixes, suggestions and open a pull request with the changes.
## ✍🏾 Author
* Franck Ndame
## 🚨 License
```
MIT License
Copyright (c) 2019 Franck Ndame
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```