Skip to content

Commit 4710811

Browse files
Sharad24mehulrastogi
Sharad24
and
mehulrastogi
authored
Restructure (#256)
* Some details in index.rst * modify example * add GA example * basic changes to deep.py example * small corrections * add GA qlearing * GA refactor * checks passed * Pre-commit Fix * Pre-commit Fix(2) * Restructure. * Docs index.rst * Move Data Bandits to Utils * Update root __init__.py * Update __init__.pys in agents * Update core, trainers, utils, data __init__.py * Update a part of agents docs * Update more __init__.py s and tests * deep.common imports * core imports * Bandits * All imports * Missing import * Docs index.rst files Co-authored-by: mehulrastogi <[email protected]>
1 parent 1b1523e commit 4710811

File tree

183 files changed

+1345
-783
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

183 files changed

+1345
-783
lines changed

‎.gitignore

-1
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,4 @@ logs/
1414
.coverage
1515
.mypy*
1616
*.pt
17-
data/
1817
_build/

‎.pre-commit-config.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ repos:
1414
rev: 19.10b0
1515
hooks:
1616
- id: black
17-
language_version: python3.7
17+
language_version: python3.6
1818

1919
- repo: https://gitlab.com/pycqa/flake8
2020
rev: 3.7.7

‎GETTING_STARTED.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Train a Tabular Dyna-Q model from scratch on the `FrozenLake-v0` gym environment
99
```python
1010
import gym
1111

12+
from genrl.bandit import BanditTrainer, CovertypeDataBandit, NeuralLinearPosteriorAgent
1213
from genrl.classical import QLearning
1314
from genrl.classical.common import Trainer
1415

@@ -24,7 +25,6 @@ trainer.plot(episode_rewards)
2425
Use a Neural Netowrk based linear posterior inference method to train on the Covertype dataset.
2526

2627
```python
27-
from genrl.bandit import CovertypeDataBandit, NeuralLinearPosteriorAgent, BanditTrainer
2828

2929
bandit = CovertypeDataBandit()
3030
agent = NeuralLinearPosteriorAgent(bandit)

‎docs/source/api/algorithms/genrl.classical.qlearning.rst ‎docs/source/api/agents/genrl.classical.qlearning.rst

File renamed without changes.

‎docs/source/api/algorithms/genrl.classical.sarsa.rst ‎docs/source/api/agents/genrl.classical.sarsa.rst

File renamed without changes.

‎docs/source/api/algorithms/genrl.deep.agents.a2c.rst ‎docs/source/api/agents/genrl.deep.agents.a2c.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ A2C
44
Submodules
55
----------
66

7-
genrl.deep.agents.a2c.a2c module
7+
genrl.agents.deep.a2c.a2c module
88
--------------------------------
99

10-
.. automodule:: genrl.deep.agents.a2c.a2c
10+
.. automodule:: genrl.agents.deep.a2c.a2c.A2C
1111
:members:
1212
:undoc-members:
1313
:show-inheritance:
@@ -16,7 +16,7 @@ genrl.deep.agents.a2c.a2c module
1616
Module contents
1717
---------------
1818

19-
.. automodule:: genrl.deep.agents.a2c
19+
.. automodule:: genrl.agents.deep.a2c.a2c.A2C
2020
:members:
2121
:undoc-members:
2222
:show-inheritance:

‎docs/source/api/algorithms/genrl.deep.agents.ddpg.rst ‎docs/source/api/agents/genrl.deep.agents.ddpg.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ DDPG
44
Submodules
55
----------
66

7-
genrl.deep.agents.ddpg.ddpg module
7+
genrl.agents.deep.ddpg.ddpg module
88
----------------------------------
99

10-
.. automodule:: genrl.deep.agents.ddpg.ddpg
10+
.. automodule:: genrl.agents.deep.ddpg.ddpg
1111
:members:
1212
:undoc-members:
1313
:show-inheritance:
@@ -16,7 +16,7 @@ genrl.deep.agents.ddpg.ddpg module
1616
Module contents
1717
---------------
1818

19-
.. automodule:: genrl.deep.agents.ddpg
19+
.. automodule:: genrl.agents.deep.ddpg
2020
:members:
2121
:undoc-members:
2222
:show-inheritance:

‎docs/source/api/algorithms/genrl.deep.agents.dqn.rst ‎docs/source/api/agents/genrl.deep.agents.dqn.rst

+19-15
Original file line numberDiff line numberDiff line change
@@ -4,58 +4,62 @@ DQN
44
Submodules
55
----------
66

7-
genrl.deep.agents.dqn.base module
7+
genrl.agents.deep.dqn.base module
88
---------------------------------
99

10-
.. automodule:: genrl.deep.agents.dqn.base
10+
.. automodule:: genrl.agents.deep.dqn.base
1111
:members:
1212
:undoc-members:
1313
:show-inheritance:
1414

15-
genrl.deep.agents.dqn.categorical module
15+
genrl.agents.deep.dqn.categorical module
1616
----------------------------------------
1717

18-
.. automodule:: genrl.deep.agents.dqn.categorical
18+
.. automodule:: genrl.agents.deep.dqn.categorical
1919
:members:
2020
:undoc-members:
2121
:show-inheritance:
2222

23-
genrl.deep.agents.dqn.double module
23+
genrl.agents.deep.dqn.double module
2424
-----------------------------------
2525

26-
.. automodule:: genrl.deep.agents.dqn.double
26+
.. automodule:: genrl.agents.deep.dqn.double
2727
:members:
2828
:undoc-members:
2929
:show-inheritance:
3030

31-
genrl.deep.agents.dqn.dueling module
31+
genrl.agents.deep.dqn.dueling module
3232
------------------------------------
3333

34-
.. automodule:: genrl.deep.agents.dqn.dueling
34+
.. automodule:: genrl.agents.deep.dqn.dueling
3535
:members:
3636
:undoc-members:
3737
:show-inheritance:
3838

39-
genrl.deep.agents.dqn.noisy module
39+
genrl.agents.deep.dqn.noisy module
4040
----------------------------------
4141

42-
.. automodule:: genrl.deep.agents.dqn.noisy
42+
.. automodule:: genrl.agents.deep.dqn.noisy
4343
:members:
4444
:undoc-members:
4545
:show-inheritance:
4646

47-
genrl.deep.agents.dqn.prioritized module
47+
genrl.agents.deep.dqn.prioritized module
4848
----------------------------------------
4949

50-
.. automodule:: genrl.deep.agents.dqn.prioritized
50+
.. automodule:: genrl.agents.deep.dqn.prioritized
51+
genrl.agents.deep.dqn.dqn module
52+
--------------------------------
53+
54+
.. automodule:: genrl.agents.deep.dqn.dqn
5155
:members:
5256
:undoc-members:
5357
:show-inheritance:
5458

55-
genrl.deep.agents.dqn.utils module
59+
genrl.agents.deep.dqn.utils module
5660
----------------------------------
5761

58-
.. automodule:: genrl.deep.agents.dqn.utils
62+
.. automodule:: genrl.agents.deep.dqn.utils
5963
:members:
6064
:undoc-members:
6165
:show-inheritance:
@@ -64,7 +68,7 @@ genrl.deep.agents.dqn.utils module
6468
Module contents
6569
---------------
6670

67-
.. automodule:: genrl.deep.agents.dqn
71+
.. automodule:: genrl.agents.deep.dqn
6872
:members:
6973
:undoc-members:
7074
:show-inheritance:

‎docs/source/api/algorithms/genrl.deep.agents.ppo1.rst ‎docs/source/api/agents/genrl.deep.agents.ppo1.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ PPO1
44
Submodules
55
----------
66

7-
genrl.deep.agents.ppo1.ppo1 module
7+
genrl.agents.deep.ppo1.ppo1 module
88
----------------------------------
99

10-
.. automodule:: genrl.deep.agents.ppo1.ppo1
10+
.. automodule:: genrl.agents.deep.ppo1.ppo1
1111
:members:
1212
:undoc-members:
1313
:show-inheritance:
@@ -16,7 +16,7 @@ genrl.deep.agents.ppo1.ppo1 module
1616
Module contents
1717
---------------
1818

19-
.. automodule:: genrl.deep.agents.ppo1
19+
.. automodule:: genrl.agents.deep.ppo1
2020
:members:
2121
:undoc-members:
2222
:show-inheritance:

‎docs/source/api/algorithms/genrl.deep.agents.sac.rst ‎docs/source/api/agents/genrl.deep.agents.sac.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ SAC
44
Submodules
55
----------
66

7-
genrl.deep.agents.sac.sac module
7+
genrl.agents.deep.sac.sac module
88
--------------------------------
99

10-
.. automodule:: genrl.deep.agents.sac.sac
10+
.. automodule:: genrl.agents.deep.sac.sac
1111
:members:
1212
:undoc-members:
1313
:show-inheritance:
@@ -16,7 +16,7 @@ genrl.deep.agents.sac.sac module
1616
Module contents
1717
---------------
1818

19-
.. automodule:: genrl.deep.agents.sac
19+
.. automodule:: genrl.agents.deep.sac
2020
:members:
2121
:undoc-members:
2222
:show-inheritance:

‎docs/source/api/algorithms/genrl.deep.agents.td3.rst ‎docs/source/api/agents/genrl.deep.agents.td3.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ TD3
44
Submodules
55
----------
66

7-
genrl.deep.agents.td3.td3 module
7+
genrl.agents.deep.td3.td3 module
88
--------------------------------
99

10-
.. automodule:: genrl.deep.agents.td3.td3
10+
.. automodule:: genrl.agents.deep.td3.td3
1111
:members:
1212
:undoc-members:
1313
:show-inheritance:
@@ -16,7 +16,7 @@ genrl.deep.agents.td3.td3 module
1616
Module contents
1717
---------------
1818

19-
.. automodule:: genrl.deep.agents.td3
19+
.. automodule:: genrl.agents.deep.td3
2020
:members:
2121
:undoc-members:
2222
:show-inheritance:

‎docs/source/api/algorithms/genrl.deep.agents.vpg.rst ‎docs/source/api/agents/genrl.deep.agents.vpg.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ VPG
44
Submodules
55
----------
66

7-
genrl.deep.agents.vpg.vpg module
7+
genrl.agents.deep.vpg.vpg module
88
--------------------------------
99

10-
.. automodule:: genrl.deep.agents.vpg.vpg
10+
.. automodule:: genrl.agents.deep.vpg.vpg
1111
:members:
1212
:undoc-members:
1313
:show-inheritance:
@@ -16,7 +16,7 @@ genrl.deep.agents.vpg.vpg module
1616
Module contents
1717
---------------
1818

19-
.. automodule:: genrl.deep.agents.vpg
19+
.. automodule:: genrl.agents.deep.vpg
2020
:members:
2121
:undoc-members:
2222
:show-inheritance:

‎docs/source/api/agents/index.rst

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Agents
2+
=========
3+
4+
.. toctree::
5+
:maxdepth: 1
6+
:caption: Deep
7+
8+
genrl.agents.deep.a2c
9+
genrl.agents.deep.ddpg
10+
genrl.agents.deep.dqn
11+
genrl.agents.deep.ppo1
12+
genrl.agents.deep.vpg
13+
genrl.agents.deep.td3
14+
genrl.agents.deep.sac
15+
16+
17+
18+
.. toctree::
19+
:maxdepth: 1
20+
:caption: Classical
21+
22+
genrl.agents.classical.qlearning
23+
genrl.agents.classical.sarsa

‎docs/source/api/algorithms/index.rst

-21
This file was deleted.

‎docs/source/api/bandit/genrl.bandit.agents.cb_agents.rst

+18-18
Original file line numberDiff line numberDiff line change
@@ -7,71 +7,71 @@ Subpackages
77
.. toctree::
88
:maxdepth: 4
99

10-
genrl.bandit.agents.cb_agents.common
10+
genrl.agents.bandits.contextual.common
1111

1212
Submodules
1313
----------
1414

15-
genrl.bandit.agents.cb\_agents.base module
15+
genrl.agents.bandits.contextual.base module
1616
------------------------------------------
1717

18-
.. automodule:: genrl.bandit.agents.cb_agents.base
18+
.. automodule:: genrl.agents.bandits.contextual.base
1919
:members:
2020
:undoc-members:
2121
:show-inheritance:
2222

23-
genrl.bandit.agents.cb\_agents.bootstrap\_neural module
23+
genrl.agents.bandits.contextual.bootstrap\_neural module
2424
-------------------------------------------------------
2525

26-
.. automodule:: genrl.bandit.agents.cb_agents.bootstrap_neural
26+
.. automodule:: genrl.agents.bandits.contextual.bootstrap_neural
2727
:members:
2828
:undoc-members:
2929
:show-inheritance:
3030

31-
genrl.bandit.agents.cb\_agents.fixed module
31+
genrl.agents.bandits.contextual.fixed module
3232
-------------------------------------------
3333

34-
.. automodule:: genrl.bandit.agents.cb_agents.fixed
34+
.. automodule:: genrl.agents.bandits.contextual.fixed
3535
:members:
3636
:undoc-members:
3737
:show-inheritance:
3838

39-
genrl.bandit.agents.cb\_agents.linpos module
39+
genrl.agents.bandits.contextual.linpos module
4040
--------------------------------------------
4141

42-
.. automodule:: genrl.bandit.agents.cb_agents.linpos
42+
.. automodule:: genrl.agents.bandits.contextual.linpos
4343
:members:
4444
:undoc-members:
4545
:show-inheritance:
4646

47-
genrl.bandit.agents.cb\_agents.neural\_greedy module
47+
genrl.agents.bandits.contextual.neural\_greedy module
4848
----------------------------------------------------
4949

50-
.. automodule:: genrl.bandit.agents.cb_agents.neural_greedy
50+
.. automodule:: genrl.agents.bandits.contextual.neural_greedy
5151
:members:
5252
:undoc-members:
5353
:show-inheritance:
5454

55-
genrl.bandit.agents.cb\_agents.neural\_linpos module
55+
genrl.agents.bandits.contextual.neural\_linpos module
5656
----------------------------------------------------
5757

58-
.. automodule:: genrl.bandit.agents.cb_agents.neural_linpos
58+
.. automodule:: genrl.agents.bandits.contextual.neural_linpos
5959
:members:
6060
:undoc-members:
6161
:show-inheritance:
6262

63-
genrl.bandit.agents.cb\_agents.neural\_noise\_sampling module
63+
genrl.agents.bandits.contextual.neural\_noise\_sampling module
6464
-------------------------------------------------------------
6565

66-
.. automodule:: genrl.bandit.agents.cb_agents.neural_noise_sampling
66+
.. automodule:: genrl.agents.bandits.contextual.neural_noise_sampling
6767
:members:
6868
:undoc-members:
6969
:show-inheritance:
7070

71-
genrl.bandit.agents.cb\_agents.variational module
71+
genrl.agents.bandits.contextual.variational module
7272
-------------------------------------------------
7373

74-
.. automodule:: genrl.bandit.agents.cb_agents.variational
74+
.. automodule:: genrl.agents.bandits.contextual.variational
7575
:members:
7676
:undoc-members:
7777
:show-inheritance:
@@ -80,7 +80,7 @@ genrl.bandit.agents.cb\_agents.variational module
8080
Module contents
8181
---------------
8282

83-
.. automodule:: genrl.bandit.agents.cb_agents
83+
.. automodule:: genrl.agents.bandits.contextual
8484
:members:
8585
:undoc-members:
8686
:show-inheritance:

0 commit comments

Comments
 (0)