| name | upload-youtube-video |
| description | Upload or update YouTube model preview videos from rlab, especially RL gameplay previews associated with Hugging Face model cards. Use when the user asks to upload a local video to YouTube, update an existing video description/title/tags/privacy, add a video to a playlist, produce OAuth authorization flow instructions, or ensure model-card preview videos have clean clickable model links. |
Upload YouTube Video
Contract
Publish a local preview video to the user's YouTube account, connect it to the associated model page, and leave enough metadata for future agents to update or verify it.
Prefer the repo uploader script at scripts/upload_youtube_video.py. It uses .secret/youtube_client_secret.json and stores the OAuth token at .secret/youtube_token.json; do not print secret or token contents.
Before Uploading
- Confirm the local video path, title, model page URL, and privacy status. Default privacy to
public unless the user asks otherwise.
- For model preview videos, prefer adding them to the
rlab playlist unless the user asks for a different playlist.
- Check the model page URL is direct and fully qualified. Prefer
https://huggingface.co/<owner>/<repo> over redirect/short domains such as https://hf.co/....
- For gameplay preview videos, set a custom YouTube thumbnail from the local video at 10 seconds by default. The repo uploader does this automatically unless
--no-thumbnail is passed. If the video is shorter than 10 seconds, use the last safe frame the uploader selects.
- If the user needs OAuth again, run the uploader with
--no-browser only when appropriate and relay the printed authorization URL. After the user says they authorized it, continue the waiting process; do not restart unless the callback failed.
Description Format
Use a human-readable, game-agnostic title shape for RL/model preview videos:
<Game Display Name> <Level/State Display Name> Solved by <ALGORITHM> - <win-rate> Win Rate
Examples:
Super Mario Bros NES Level 1-2 Solved by PPO - 100% Win Rate
Mega Man NES Cut Man Solved by PPO - 100% Win Rate
If completion rate is below the solved threshold, use Played by instead of Solved by.
Use this description shape for RL/model preview videos:
A <ALGORITHM> reinforcement learning agent completes <Game Display Name> <Level/State Display Name> with a <win-rate> local eval win rate.
Model: https://huggingface.co/<owner>/<repo>
rlab: https://github.com/tsilva/rlab
#ReinforcementLearning #<ALGORITHM> #<GameName>
Rules:
- Keep titles compact and scannable: human game name, level/state, algorithm, and headline outcome.
- Prefer human display names over raw env ids in titles/descriptions. For example, use
Super Mario Bros NES instead of SuperMarioBros-Nes-v0, and Level 1-2 instead of Level1-2.
- Start with a concise human-readable description of what the video shows.
- Mention that the checkpoint was trained with
rlab in the first sentence when true.
- Put the
Model: link before the rlab: link.
- Keep the link labels short and plain:
rlab: and Model:.
- Include up to three visible hashtags at the end of the description:
#ReinforcementLearning, #<ALGORITHM>, and one compact game hashtag such as #SuperMarioBros or #MegaMan.
- Add hidden tags for search/context: reinforcement learning, deep reinforcement learning, AI gameplay, stable-baselines3, Stable Retro, rlab, algorithm, raw game id, human game name, raw level/state id, and human level/state name.
- Avoid shorteners and redirect domains for YouTube descriptions; they can be visually truncated or treated suspiciously by YouTube.
- Expect YouTube to visually ellipsize long links in collapsed views even when the actual link is correct and clickable.
- Include extra eval claims only when the user asks for them or when they are needed for the video description and are backed by the current model card, eval database, W&B artifact metadata, or generated summary files.
Upload Command
Use the script from the repo root:
python3 scripts/upload_youtube_video.py <video.mp4> \
--title "<Game Display Name> <Level/State Display Name> Solved by PPO - <win-rate> Win Rate" \
--human-description "A PPO reinforcement learning agent completes <Game Display Name> <Level/State Display Name> with a <win-rate> local eval win rate." \
--model-page $'Model: https://huggingface.co/<owner>/<repo>\nrlab: https://github.com/tsilva/rlab' \
--description "#ReinforcementLearning #PPO #<GameName>" \
--tags "reinforcement learning,deep reinforcement learning,AI gameplay,stable-baselines3,Stable Retro,rlab,PPO,<raw game id>,<Game Display Name>,<raw level/state id>,<Level/State Display Name>" \
--playlist-title rlab \
--privacy-status public \
--output runs/<artifact-dir>/youtube_upload_result.json
The script captures and uploads a custom thumbnail from second 10 of the video by default. Override with --thumbnail-time <seconds>, provide an explicit --thumbnail <image.jpg>, or disable with --no-thumbnail.
If the OAuth callback cannot open a browser or the user asks for the OAuth URL:
python3 scripts/upload_youtube_video.py <video.mp4> ... --no-browser
Relay the URL printed by the script and wait for the user to authorize.
Updating an Existing Video
Use --video-id to update metadata without re-uploading:
python3 scripts/upload_youtube_video.py \
--video-id <youtube-video-id> \
--title "<Game Display Name> <Level/State Display Name> Solved by PPO - <win-rate> Win Rate" \
--human-description "A PPO reinforcement learning agent completes <Game Display Name> <Level/State Display Name> with a <win-rate> local eval win rate." \
--model-page $'Model: https://huggingface.co/<owner>/<repo>\nrlab: https://github.com/tsilva/rlab' \
--description "#ReinforcementLearning #PPO #<GameName>" \
--privacy-status public \
--output runs/<artifact-dir>/youtube_upload_result.json \
--no-browser
The update path preserves existing title and tags unless replacements are passed.
Verification
After upload or update:
- Read the JSON output and report the YouTube URL, playlist URL when present, and the final description shape.
- Verify the model link is direct
https://huggingface.co/... and appears on a Model: line.
- For new gameplay uploads, verify the JSON includes
thumbnail.path and a successful thumbnail.upload response, or report the thumbnail API failure clearly if the account does not allow custom thumbnails.
- Run
python3 -m py_compile scripts/upload_youtube_video.py after changing the uploader script.
- If the user reports link issues and the stored description is correct, distinguish visual truncation from actual clickability. For clickability issues, check account verification, Shorts vs normal video, direct URL formatting, redirect domains, and whether the issue is only in a collapsed/mobile view.
Repo Rules
When YouTube upload policy or description conventions change, encode detailed rules here first. Keep AGENTS.md as a short trigger pointer to this skill, not the detailed source of truth.
