You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Getting Started/introduction.md
+14-11Lines changed: 14 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,28 +7,31 @@ sidebar_position: 1
7
7
8
8
## What is RLGym?
9
9
10
-
RLGym is a Python API for creating reinforcement learning environments. While it was originally designed for the game [Rocket League](https://www.rocketleague.com), the core API is now game-agnostic. This means you can use RLGym to create any kind of environment you want, from simple grid worlds to complex physics simulations. Get an overview of how RLGym works in our [overview](/Getting%20Started/overview) section.
10
+
RLGym is a Python API for creating reinforcement learning environments. While it was originally designed for the game [Rocket League](https://www.rocketleague.com), the core API is now game-agnostic. This means you can use RLGym to create any kind of environment you want, from simple grid worlds to complex physics simulations. Get an overview of the API in our [overview](/Getting%20Started/overview) section.
11
11
12
12
## How it Works
13
-
RLGym provides a simple API for creating fully customizable environments for reinforcement learning projects. Each environment is built from a few core components, which we refer to as "configuration objects". When provided with a set of configuration objects, RLGym will handle the flow of information throughout the environment, and provide a simple interface for learning agents to interact with the environment.
13
+
RLGym provides a simple API for creating fully customizable environments for reinforcement learning projects. Each environment is built from a few core components, which we refer to as "configuration objects". When provided with a set of configuration objects, RLGym will handle the flow of information throughout the environment, and provide a simple interface for learning agents to interact with.
14
14
15
15
## Getting Started
16
16
17
-
The most developed use of RLGym is for Rocket League. We provide a complete environment implementation that allows users to train agents with [RocketSim](https://github.com/ZealanL/rocketsim), a headless simulator for Rocket League. Users can customize every aspect of the environment by implementing their own [Configuration Objects](/Getting%20Started/overview/), or use the default implementations provided by RLGym. Head over to our [Quick Start Guide](quickstart.md) if you want to jump right in to training a Rocket League agent, or check out our [Custom Environments](../../Custom%20Environments/custom-environment) section for a step-by-step guide to creating your own environment with the RLGym API.
17
+
The most developed use of RLGym is for Rocket League. We provide a complete environment implementation that allows users to train agents with [RocketSim](https://github.com/ZealanL/rocketsim), a headless simulator for Rocket League. Users can customize every aspect of the environment by implementing their own [Configuration Objects](/Getting%20Started/overview/), or use the default implementations provided by RLGym. Head over to our [Quickstart Guide](quickstart.md) if you want to jump right in to training a Rocket League agent, or check out our [Custom Environments](../../Custom%20Environments/custom-environment) section for a step-by-step guide to creating your own environment with the RLGym API.
18
18
19
19
## Installation
20
20
RLGym is split into several packages to keep things modular and lightweight. The core API package has no dependencies, while additional packages provide specific functionality:
21
21
22
22
```bash
23
-
#Just the core API
24
-
pip install rlgym
23
+
#Installs every rlgym component
24
+
pip install rlgym[all]
25
25
26
-
#Everything for Rocket League with RocketSim
27
-
pip install rlgym[rl-sim]
26
+
#Installs only the api
27
+
pip install rlgym
28
28
29
-
#Everything for Rocket League with RocketSim and RLViser (visualization)
30
-
pip install rlgym[rl-rlviser]
29
+
#Installs all rocket league packages
30
+
pip install rlgym[rl]
31
31
32
-
# All packages
33
-
pip install rlgym[all]
32
+
# Installs only RocketSim rocket league packages
33
+
pip install rlgym[rl-sim]
34
+
35
+
# Installs RLViser and RocketSim rocket league packages
Copy file name to clipboardExpand all lines: docs/Getting Started/quickstart.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -105,4 +105,4 @@ if __name__ == "__main__":
105
105
106
106
This code will train a 2v2 bot for 1 billion timesteps (That's over 18,500 hours of in-game time!), saving checkpoints every 1 million timesteps. You can stop the training process at any time by pressing P while the program is in focus.
107
107
108
-
For a more complete guide for training your first agent, refer to our Rocket League tutorial on [training an agent](../Rocket%20League/training_an_agent).
108
+
For a more complete guide to training your first agent, refer to our Rocket League tutorial on [training an agent](../Rocket%20League/training_an_agent).
0 commit comments