(examples)=

# Examples

## Example on Google Colab
We provide an in-depth example of mobile-env's usage on Google Colab! The notebook shows how to train multi-agent reinforcement learning policies with [RLlib](https://docs.ray.io/en/stable/rllib.html) and centralized control policies with [stable-baselines3](https://stable-baselines3.readthedocs.io/en/master/index.html).


[![Open in colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/stefanbschneider/mobile-env/blob/master/examples/demo.ipynb)

## Environment Creation
`mobile-env` follows the [Gymnasium interface](https://gymnasium.farama.org/).
Here is an example of how mobile-env's environments can be created:
```python
import gymnasium
import mobile_env

# small environment; centralized control
env = gymnasium.make('mobile-small-central-v0')

# large environment; centralized control
env = gymnasium.make('mobile-large-central-v0')

# small environment; multi-agent control
env = gymnasium.make('mobile-large-ma-v0')
...

# then run the environment
obs, info = env.reset()
done = False

while not done:
    action = ... # Your agent code here
    obs, reward, terminated, truncated, info = env.step(action)
    done = terminated or truncated
    env.render()
```