[update] update readme for ssh port forwarding

yzqin · yzqin · commit 2378e0c9c64c · 2023-08-21T21:32:01.000-07:00
diff --git a/example/isaacgym/train_isaacgym_remote_server.ipynb b/example/isaacgym/train_isaacgym_remote_server.ipynb
@@ -12,13 +12,16 @@
     "from pathlib import Path\n",
     "from ctypes import cdll\n",
     "import sys\n",
+    "\n",
     "is_conda = 'CONDA_PREFIX' in os.environ or 'CONDA_DEFAULT_ENV' in os.environ\n",
     "if is_conda:\n",
     "    version_info = sys.version_info\n",
     "    if version_info.major == 3 and version_info.minor >= 8:\n",
-    "        conda_lib_path = Path(sys.executable).parent.parent / f\"lib/libpython{version_info.major}.{version_info.minor}.so.1.0\"\n",
+    "        conda_lib_path = Path(\n",
+    "            sys.executable).parent.parent / f\"lib/libpython{version_info.major}.{version_info.minor}.so.1.0\"\n",
     "    else:\n",
-    "        conda_lib_path = Path(sys.executable).parent.parent / f\"lib/libpython{version_info.major}.{version_info.minor}m.so.1.0\"\n",
+    "        conda_lib_path = Path(\n",
+    "            sys.executable).parent.parent / f\"lib/libpython{version_info.major}.{version_info.minor}m.so.1.0\"\n",
     "    python_lib = cdll.LoadLibrary(str(conda_lib_path))\n",
     "    print(f\"Load Python lib {conda_lib_path}\")\n"
    ]
@@ -83,7 +86,8 @@
     "vec_task.VecTask.create_sim = wrapped_create_sim\n",
     "\n",
     "# Create web visualizer\n",
-    "web_visualizer = create_isaac_visualizer(port=6000, host=\"localhost\", keep_default_viewer=False, max_env=16, scene_offset=np.array([40.0, 40.0]))\n",
+    "web_visualizer = create_isaac_visualizer(port=6000, host=\"localhost\", keep_default_viewer=False, max_env=16,\n",
+    "                                         scene_offset=np.array([40.0, 40.0]))\n",
     "\n",
     "\n",
     "################################################################################################\n",
@@ -292,6 +296,8 @@
    "outputs": [],
    "source": [
     "# Modify the IP if the jupyter server is not localhost\n",
+    "# If your remote server has a public ip, the machine ip should be that one\n",
+    "# If you are using ssh port forwarding like: ssh YOUR_SERVER -L 7000:localhost:7000 to forward port 7000 from your server to local machine, it should still be your localhost\n",
     "machine_ip = \"127.0.0.1\"\n",
     "web_visualizer.jupyter_cell(url=f\"http://{machine_ip}:7000/static/\", height=400)"
    ]
