Farama-Foundation / Gymnasium

An API standard for single-agent reinforcement learning environments, with popular reference environments and related utilities (formerly Gym)
https://gymnasium.farama.org
MIT License
6.94k stars 773 forks source link

[Bug Report] Code examples in Vector API documentation use deprecated "gym.vector.make" instead of "gym.make_vec" #1047

Closed LetteraUnica closed 4 months ago

LetteraUnica commented 4 months ago

Describe the bug

I found that code examples in the vector API documentation, at https://gymnasium.farama.org/api/vector/examples use the deprecated method gym.vector.make instead of the method gym.make_vec.

If this is intended feel free to close this issue, otherwise I would be glad to work on this since it seems like a simple change.

Code example

## Current example for creating a vector env on the documentation
import gymnasium as gym
envs = gym.vector.make("CartPole-v1", num_envs=3)
envs.reset(seed=42)

System info

No response

Additional context

No response

Checklist

pseudo-rnd-thoughts commented 4 months ago

Could you check if this is still an issue on the main version of the website?

LetteraUnica commented 4 months ago

If you mean the documentation present on the main branch, I've just built it and the issue with the use of gym.vector.make seems to not be present

pseudo-rnd-thoughts commented 4 months ago

Ok, perfect, then I don't think there is an issue then I will close