Skip to content

Commit 4f52f7c

Browse files
committed
2 parents db61569 + 5dba106 commit 4f52f7c

File tree

2 files changed

+77
-1
lines changed

2 files changed

+77
-1
lines changed
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Discord Notification
2+
on: push # Triggers on every push
3+
jobs:
4+
notify:
5+
runs-on: ubuntu-latest
6+
steps:
7+
- name: Send Discord Notification
8+
uses: Ilshidur/action-discord@master
9+
with:
10+
args: |
11+
**New commit in ${{ github.repository }}**
12+
> **Author:** ${{ github.actor }}
13+
> **Message:** ${{ github.event.head_commit.message }}
14+
> [View Commit](${{ github.server_url }}/${{ github.repository }}/commit/${{ github.sha }})
15+
env:
16+
DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}

README.md

Lines changed: 61 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,61 @@
1-
# baiby-steps
1+
2+
# 🤖 b{AI}by Steps – Train Your Own 3D Walker
3+
4+
Welcome to **b{AI}by Steps**, a reinforcement learning project where club members create, train, and test custom 3D walkers using Python, Gymnasium, and physics simulators. The walkers are trained to navigate challenging terrains and evaluated based on performance, robustness, and creativity.
5+
6+
---
7+
8+
## 🎯 Project Goals
9+
10+
- Build multiple 3D walkers (humanoids, bipeds, quadrupeds, etc.)
11+
- Create and modify diverse terrain environments
12+
- Train policies using reinforcement learning (PPO, A2C)
13+
- Evaluate and compare walker performance across terrains
14+
- Showcase walker competition at semester’s end 🎉
15+
16+
---
17+
18+
## 🧠 Technologies
19+
20+
- [Python 3.10+](https://www.python.org/)
21+
- [Gymnasium](https://gymnasium.farama.org/)
22+
- [PyBullet](https://pybullet.org/wordpress/)
23+
- [Stable-Baselines3](https://stable-baselines3.readthedocs.io/)
24+
- NumPy, Matplotlib
25+
26+
---
27+
## 🙋 How to Contribute
28+
We welcome contributors of all skill levels!
29+
- Pick an issue from GitHub Issues
30+
- Write README, issues, and instructions
31+
- Add new walkers (`walkers/`)
32+
- Create terrain environments (`terrains/`)
33+
- Improve the training/evaluation scripts
34+
- Visualize reward curves or gait animations
35+
36+
---
37+
## 📖 Recommended Learning
38+
We'll be using the gymnasium library to create our environments. I recommend reading the gymnasium documentation and following the steps to create some of the simpler pre-existing environments -
39+
[here](https://gymnasium.farama.org/introduction/basic_usage/)
40+
41+
Here are some good YouTube videos too:
42+
- [The FASTEST introduction to Reinforcement Learning on the internet
43+
](https://www.youtube.com/watch?v=VnpRp7ZglfA&t=4155s)
44+
45+
## 🔧 How to Get Started
46+
47+
### 1. Clone the Repository
48+
49+
```bash
50+
git clone https://github.com/codenetwork/baiby-steps
51+
cd baiby-steps
52+
```
53+
### 2. Create a Virtual Environment
54+
```bash
55+
python -m venv venv
56+
source venv/bin/activate # Windows: venv\Scripts\activate
57+
```
58+
### 3. Install Dependencies
59+
```bash
60+
pip install -r requirements.txt
61+
```

0 commit comments

Comments
 (0)