rollout notebook boilerplate

Author: aftersomemath

python/rollout.ipynb

@@ -0,0 +1,152 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "6adc68e0-a943-44ab-9af5-4bc62cc19f34",
+   "metadata": {
+    "id": "MpkYHwCqk7W-"
+   },
+   "source": [
+    "![MuJoCo banner](https://raw.githubusercontent.com/google-deepmind/mujoco/main/banner.png)\n",
+    "\n",
+    "# <h1><center>Rollout Tutorial <a href=\"https://colab.research.google.com/github/google-deepmind/mujoco/blob/main/python/rollout.ipynb\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" width=\"140\" align=\"center\"/></a></center></h1>\n",
+    "\n",
+    "This notebook provides a tutorial for [**MuJoCo** physics](https://github.com/google-deepmind/mujoco#readme), using the native Python bindings.\n",
+    "\n",
+    "This notebook describes a utility included in the MuJoCo Python library that performs simulation \"rollouts\" with an underlying C++ function. The rollouts can be multithreaded. We provide examples of the speed of rollout compared to pure Python rollouts and MJX and give an application example that couples \"rollout\" with MuJoCo's \"minimze\" utility.\n",
+    "\n",
+    "<!-- Copyright 2025 DeepMind Technologies Limited\n",
+    "\n",
+    "     Licensed under the Apache License, Version 2.0 (the \"License\");\n",
+    "     you may not use this file except in compliance with the License.\n",
+    "     You may obtain a copy of the License at\n",
+    "\n",
+    "         http://www.apache.org/licenses/LICENSE-2.0\n",
+    "\n",
+    "     Unless required by applicable law or agreed to in writing, software\n",
+    "     distributed under the License is distributed on an \"AS IS\" BASIS,\n",
+    "     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n",
+    "     See the License for the specific language governing permissions and\n",
+    "     limitations under the License.\n",
+    "-->"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "c14f80a6-17c3-4199-a822-7ea48964b7ca",
+   "metadata": {
+    "id": "YvyGCsgSCxHQ"
+   },
+   "source": [
+    "# All imports"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "0f9fbad1-59d0-40ac-b2b6-99f37313670f",
+   "metadata": {
+    "id": "Xqo7pyX-n72M"
+   },
+   "outputs": [],
+   "source": [
+    "!pip install mujoco\n",
+    "\n",
+    "# Set up GPU rendering.\n",
+    "from google.colab import files\n",
+    "import distutils.util\n",
+    "import osc\n",
+    "import subprocess\n",
+    "if subprocess.run('nvidia-smi').returncode:\n",
+    "  raise RuntimeError(\n",
+    "      'Cannot communicate with GPU. '\n",
+    "      'Make sure you are using a GPU Colab runtime. '\n",
+    "      'Go to the Runtime menu and select Choose runtime type.')\n",
+    "\n",
+    "# Add an ICD config so that glvnd can pick up the Nvidia EGL driver.\n",
+    "# This is usually installed as part of an Nvidia driver package, but the Colab\n",
+    "# kernel doesn't install its driver via APT, and as a result the ICD is missing.\n",
+    "# (https://github.com/NVIDIA/libglvnd/blob/master/src/EGL/icd_enumeration.md)\n",
+    "NVIDIA_ICD_CONFIG_PATH = '/usr/share/glvnd/egl_vendor.d/10_nvidia.json'\n",
+    "if not os.path.exists(NVIDIA_ICD_CONFIG_PATH):\n",
+    "  with open(NVIDIA_ICD_CONFIG_PATH, 'w') as f:\n",
+    "    f.write(\"\"\"{\n",
+    "    \"file_format_version\" : \"1.0.0\",\n",
+    "    \"ICD\" : {\n",
+    "        \"library_path\" : \"libEGL_nvidia.so.0\"\n",
+    "    }\n",
+    "}\n",
+    "\"\"\")\n",
+    "\n",
+    "# Configure MuJoCo to use the EGL rendering backend (requires GPU)\n",
+    "print('Setting environment variable to use GPU rendering:')\n",
+    "%env MUJOCO_GL=egl\n",
+    "\n",
+    "# Check if installation was succesful.\n",
+    "try:\n",
+    "  print('Checking that the installation succeeded:')\n",
+    "  import mujoco\n",
+    "  mujoco.MjModel.from_xml_string('<mujoco/>')\n",
+    "except Exception as e:\n",
+    "  raise e from RuntimeError(\n",
+    "      'Something went wrong during installation. Check the shell output above '\n",
+    "      'for more information.\\n'\n",
+    "      'If using a hosted Colab runtime, make sure you enable GPU acceleration '\n",
+    "      'by going to the Runtime menu and selecting \"Choose runtime type\".')\n",
+    "\n",
+    "print('Installation successful.')\n",
+    "\n",
+    "# Other imports and helper functions\n",
+    "import time\n",
+    "import itertools\n",
+    "import numpy as np\n",
+    "\n",
+    "# Graphics and plotting.\n",
+    "print('Installing mediapy:')\n",
+    "!command -v ffmpeg >/dev/null || (apt update && apt install -y ffmpeg)\n",
+    "!pip install -q mediapy\n",
+    "import mediapy as media\n",
+    "import matplotlib.pyplot as plt\n",
+    "\n",
+    "# More legible printing from numpy.\n",
+    "np.set_printoptions(precision=3, suppress=True, linewidth=100)\n",
+    "\n",
+    "from IPython.display import clear_output\n",
+    "clear_output()\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "0de33571-592a-4021-a970-86224a7dc4da",
+   "metadata": {
+    "id": "nqqtSIkGe-ay"
+   },
+   "source": [
+    "# `rollout.rollout`\n",
+    "\n",
+    "The `rollout.rollout` function in the `mujoco` Python library runs the simulation for a fixed number steps. It can run in single or multi-threaded modes. The speedup over pure Python is significant."
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.12"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}