File size: 1,727 Bytes
ed284e7
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
236a3f3
ed284e7
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
---

tags:
- CartPole-v1
- reinforcement-learning
- rl-framework
model-index:
- name: Imitation-BC-CartPole-v1
  results:
  - task:
      type: reinforcement-learning
      name: reinforcement-learning
    dataset:
      name: CartPole-v1
      type: CartPole-v1
    metrics:
    - type: mean_reward
      value: 500.00 +/- 0.00
      name: mean_reward
      verified: false
---



# Custom implemented PPO agent playing on *CartPole-v1*

This is a trained model of an agent playing on the environment *CartPole-v1*.
The agent was trained with a PPO algorithm.
See further agent and evaluation metadata in the according README section.


## Import
The Python module used for training and uploading/downloading is [rl-framework](https://github.com/alexander-zap/rl-framework).
It is an easy-to-read, plug-and-use Reinforcement Learning framework and provides standardized interfaces
and implementations to various Reinforcement Learning methods and environments.

Also it provides connectors for the upload and download to popular model version control systems,
including the HuggingFace Hub.

## Usage
```python



from rl-framework import ImitationAgent, ImitationAlgorithm



# Create new agent instance

agent = ImitationAgent(

    algorithm=ImitationAlgorithm.PPO

    algorithm_parameters={

        ...

    },

)



# Download existing agent from HF Hub

repository_id = "zap-thamm/Imitation-BC-CartPole-v1"

file_name = "agent.pkl"

agent.download(repository_id=repository_id, filename=file_name)



```

Further examples can be found in the [exploration section of the rl-framework repository](https://github.com/alexander-zap/rl-framework/tree/main/exploration).