# Использование RL-Baselines3-Zoo на Hugging Face

`rl-baselines3-zoo` — это фреймворк для обучения с подкреплением на базе Stable Baselines3.

## Исследование RL-Baselines3-Zoo в Hub

Модели RL-Baselines3-Zoo можно найти, отфильтровав их на [странице моделей](https://huggingface.co/models?library=stable-baselines3) с помощью панели слева.

Команда Stable-Baselines3 разместила коллекцию из более чем 150 обученных агентов с подстроенными гиперпараметрами, которую можно найти [здесь](https://huggingface.co/sb3).

Все модели на Hub поставляются с полезными функциями:
1. Автоматически сгенерированная карточка модели с описанием, конфигурацией обучения и другими сведениями.
2. Метки метаданных, которые помогают в поиске.
3. Результаты оценки для сравнения с другими моделями.
4. Виджет с видео, где можно посмотреть, как работает ваш агент.

## Использование существующих моделей
Вы можете просто скачать модель с Hub с помощью `load_from_hub`:

```
# Download ppo SpaceInvadersNoFrameskip-v4 model and save it into the logs/ folder
python -m rl_zoo3.load_from_hub --algo dqn --env SpaceInvadersNoFrameskip-v4 -f logs/ -orga sb3
python enjoy.py --algo dqn --env SpaceInvadersNoFrameskip-v4  -f logs/
```

Вы можете определить три параметра:
- `--repo-name`: имя репозитория.
- `-orga`: имя пользователя или организации Hugging Face.
- `-f`: целевая папка.

## Обмен моделями
Вы можете легко загрузить свои модели с помощью `push_to_hub`. Это сохранит модель, проведёт её оценку, сгенерирует карточку модели и запишет видео с повтором действий вашего агента перед отправкой полного репозитория в Hub.

```
python -m rl_zoo3.push_to_hub  --algo dqn  --env SpaceInvadersNoFrameskip-v4  --repo-name dqn-SpaceInvadersNoFrameskip-v4  -orga ThomasSimonini  -f logs/
```

Вы можете определить три параметра:
- `--repo-name`: имя репозитория.
- `-orga`: ваше имя пользователя Hugging Face.
- `-f`: папка, в которой сохраняется модель.

## Дополнительные ресурсы

* RL-Baselines3-Zoo [официальные обученные модели](https://huggingface.co/sb3)
* RL-Baselines3-Zoo [документация](https://github.com/DLR-RM/rl-baselines3-zoo)