doc: add TransformerEngine installation instruction (#498)

2noise · Jun 28, 2024 · e5ea663 · e5ea663
1 parent ade2f46
commit e5ea663
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -92,6 +92,14 @@ conda activate chattts
 pip install -r requirements.txt
 ```
 
+#### Optional: Install TransformerEngine if using NVIDIA GPU
+> [!Note]
+> The installation process is very slow.
+
+```bash
+!pip install git+https://github.com/NVIDIA/TransformerEngine.git@stable
+```
+
 ### Quick Start
 > Make sure you are under the project root directory when you execute these commands below.
 

diff --git a/examples/ipynb/colab.ipynb b/examples/ipynb/colab.ipynb
@@ -19,7 +19,22 @@
    "source": [
     "!cd /content\n",
     "!rm -rf sample_data ChatTTS\n",
-    "!git clone https://github.com/2noise/ChatTTS.git\n",
+    "!git clone https://github.com/2noise/ChatTTS.git"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Install Requirements"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
     "!pip install -r /content/ChatTTS/requirements.txt\n",
     "!ldconfig /usr/lib64-nvidia"
    ]
@@ -30,7 +45,7 @@
     "id": "zdzEFoknxqTH"
    },
    "source": [
-    "## Import Libs"
+    "## Import Packages"
    ]
   },
   {