update installation instructions

BirkhoffG · May 28, 2024 · c722a81 · c722a81
1 parent b5b2242
commit c722a81
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 7 deletions.
diff --git a/nbs/tutorials/contribution.ipynb b/nbs/tutorials/contribution.ipynb
@@ -59,7 +59,7 @@
  "For running `ReLax` in CPU, you should\n",
  "\n",
  "```bash\n",
- "pip install jax-relax\n",
+ "pip install \"jax-relax[dev]\"\n",
  "```\n",
  "\n",
  "Next, install [Quarto](https://quarto.org/docs/get-started/) for the documentation system.\n",

diff --git a/nbs/tutorials/install.ipynb b/nbs/tutorials/install.ipynb
@@ -88,12 +88,16 @@
  "please [report to us](https:/BirkhoffG/jax-relax/issues/new).\n",
  ":::\n",
  "\n",
- "If you wish to run relax on GPU or TPU, \n",
- "please first install this library via `pip install jax-relax`.\n",
- "\n",
- "Then, you should install the right GPU or TPU version of JAX by following steps in the \n",
+ "If you wish to run `relax` on GPU or TPU, \n",
+ "please first install this library via pypi. \n",
+ "Next, you should install the right GPU or TPU version of JAX by following steps in the \n",
  "[install guidelines](https:/google/jax#installation).\n",
- "\n"
+ "\n",
+ "For example, if you want to install a GPU version, you should run\n",
+ "\n",
+ "```bash\n",
+ "pip install jax-relax\n",
+ "```\n"
  ]
  },
  {
@@ -103,7 +107,16 @@
  "source": [
  "#### Contributor of `ReLax`\n",
  "\n",
- "See [nbdev installation](https://nbdev.fast.ai/tutorials/tutorial.html#install-quarto).\n"
+ "Install the required packages via \n",
+ "\n",
+ "```bash\n",
+ "pip install \"jax-relax[dev]\"\n",
+ "```\n",
+ "\n",
+ "Next, follow the \n",
+ "[nbdev installation](https://nbdev.fast.ai/tutorials/tutorial.html#install-quarto)\n",
+ "for further instructions. \n",
+ "Check out the [contribution guidance](contribution.ipynb) for more details. \n"
  ]
  }
  ],