File size: 3,172 Bytes
b727918
 
 
 
 
 
 
d261d8f
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
b727918
 
f5cf129
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
---
library_name: ml-agents
tags:
- Pyramids
- deep-reinforcement-learning
- reinforcement-learning
- ML-Agents-Pyramids
- PPO
- Unity
model-index:
- name: PPO-PyramidsTraining6
  results:
  - task:
      type: reinforcement-learning
      name: reinforcement-learning
    dataset:
      name: Pyramids
      type: Unity-MLAgents-Env
    metrics:
    - type: mean_reward
      value: 1.381
      name: mean_reward
      verified: false
    - type: std_reward
      value: 0.0
      name: std_reward
      verified: false
---


# ๐Ÿ›๏ธ **PPO Agent on Pyramids**

This repository contains a trained **Proximal Policy Optimization (PPO)** agent that plays the **Pyramids** environment using the [Unity ML-Agents Library](https://github.com/Unity-Technologies/ml-agents).

---

## ๐Ÿ“Š Model Card

**Model Name:** `ppo-PyramidsTraining`  
**Environment:** `Pyramids` (Unity ML-Agents)  
**Algorithm:** PPO (Proximal Policy Optimization)  
**Performance Metric:**  
- Achieves stable performance in navigating and solving pyramid-based tasks  
- Demonstrates convergence to an effective policy  

---

## ๐Ÿš€ Usage (with ML-Agents)

Documentation: [ML-Agents Toolkit Docs](https://unity-technologies.github.io/ml-agents/ML-Agents-Toolkit-Documentation/)

### Resume Training
```bash
mlagents-learn <your_configuration_file_path.yaml> --run-id=<run_id> --resume
```

### Load and Run
```python
# Example: loading the trained PPO model
# (requires Unity ML-Agents setup)
model_id = "KraTUZen/ppo-PyramidsTraining"
# Select your .nn or .onnx file from the repo
```

---

## ๐Ÿง  Notes
- The agent is trained using **PPO**, a robust on-policy algorithm widely used in Unity ML-Agents.  
- The environment involves **pyramid navigation and puzzle-solving**, requiring precision and strategy.  
- The trained model is stored as `.nn` or `.onnx` files for direct Unity integration.  

---

## ๐Ÿ“‚ Repository Structure
- `Pyramids.nn` / `Pyramids.onnx` โ†’ Trained PPO policy  
- `README.md` โ†’ Documentation and usage guide  

---

## โœ… Results
- The agent learns to navigate pyramid structures and solve tasks efficiently.  
- Demonstrates stable training and effective policy convergence using PPO.  

---

## ๐Ÿ”Ž Environment Overview
- **Observation Space:** Continuous (agent position, pyramid state, environment features)  
- **Action Space:** Continuous (movement, interaction)  
- **Objective:** Solve pyramid-based tasks and maximize rewards  
- **Reward:** Positive reward for successful task completion, penalties for failures  

---

## ๐Ÿ“š Learning Highlights
- **Algorithm:** PPO (Proximal Policy Optimization)  
- **Update Rule:** Clipped surrogate objective to ensure stable updates  
- **Strengths:** Robust, stable, widely used in Unity ML-Agents  
- **Limitations:** Requires careful tuning of hyperparameters (clip ratio, learning rate, batch size)  

---

## ๐ŸŽฎ Watch Your Agent Play
You can watch your agent **directly in your browser**:

1. Visit [Unity ML-Agents on Hugging Face](https://huggingface.co/unity)  
2. Find your model ID: `KraTUZen/ppo-PyramidsTraining`  
3. Select your `.nn` or `.onnx` file  
4. Click **Watch the agent play ๐Ÿ‘€**