Skip to content
This repository has been archived by the owner on May 6, 2021. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
findmyway authored Jan 25, 2021
1 parent 56696ad commit 6f63fc6
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,32 @@
[![CodeCoverage](https://codecov.io/gh/JuliaReinforcementLearning/ReinforcementLearningCore.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaReinforcementLearning/ReinforcementLearningCore.jl)

This package is the core component of [ReinforcementLearning.jl](https://github.com/JuliaReinforcementLearning/ReinforcementLearning.jl). It provides some typical implementations of the interfaces defined in [ReinforcementLearningBase.jl](https://github.com/JuliaReinforcementLearning/ReinforcementLearningBase.jl).


## Code Structure

```
./src
├── core (define how policies interact with environments)
├── extensions (patch code fore upstream packages are stored here)
├── policies (all policies are put here)
│ ├── agents (= policy + trajectory)
│ ├── q_based_policies
│ │ ├── explorers (select action from action-values)
│ │ └── learners (learn state-value, state-action-value, distributional value...)
│ │ └── approximators (= NN + Optimiser)
│ └── (some other common policies).jl
└── utils (Reusable functions/structures)
```

For developers who are interested in contributing, I suggest you read the source code in the following top-down order:

- `core/run.jl`
- `policies/base.jl`
- `policies/agents/agent.jl`
- `policies/agents/trajectories/trajectory.jl`
- `policies/q_based_policies/q_based_policy.jl`
- `policies/q_based_policies/learners/approximators/neural_network_approximator.jl`
- `policies/q_based_policies/explorers/weighted_explorer.jl`

Then play with the ``E`JuliaRL_BasicDQN_CartPole` `` experiment in [ReinforcementLearningZoo.jl](https://github.com/JuliaReinforcementLearning/ReinforcementLearningZoo.jl) and try to understand the runtime logic step by step. After that, you can explore other components on demand.

0 comments on commit 6f63fc6

Please sign in to comment.