From fb4caa3da5a0105154cc0a107b39a49b4dfe992d Mon Sep 17 00:00:00 2001 From: eigenvivek Date: Wed, 6 Dec 2023 16:20:17 -0500 Subject: [PATCH] Update README.md --- README.md | 13 +++++++------ notebooks/index.ipynb | 8 ++++---- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 6e0ecd3..9c0a701 100644 --- a/README.md +++ b/README.md @@ -16,19 +16,20 @@ black](https://img.shields.io/badge/Code%20style-black-black.svg)](https://githu ## Install -This will install the dependencies listed under `requirements` in -[`settings.ini`](https://github.com/eigenvivek/DiffPose/blob/9a522b04a739334b9ddb89f3a606ab78d80bc6f6/settings.ini#L42). +To install `DiffPose` and the requirements in +[`environment.yml`](https://github.com/eigenvivek/DiffPose/blob/main/environment.yml), +run: ``` zsh -pip install DiffPose +pip install diffpose ``` -The source code for the differentiable X-ray renderer is available at -[`DiffDRR`](https://github.com/eigenvivek/DiffDRR). +The differentiable X-ray renderer that powers the backend of `DiffPose` +is available at [`DiffDRR`](https://github.com/eigenvivek/DiffDRR). ## Datasets -We evaluate `DiffPose` networks on the following datasets. +We evaluate `DiffPose` networks on the following open-source datasets: | **Dataset** | **Anatomy** | **\# of Subjects** | **\# of 2D Images** | **CTs** | **X-rays** | Fiducials | |----------------------------------------------------------------------------|--------------------|:------------------:|:-------------------:|:-------:|:----------:|:---------:| diff --git a/notebooks/index.ipynb b/notebooks/index.ipynb index 67bc76b..e50943f 100644 --- a/notebooks/index.ipynb +++ b/notebooks/index.ipynb @@ -29,13 +29,13 @@ "source": [ "## Install\n", "\n", - "This will install the dependencies listed under `requirements` in [`settings.ini`](https://github.com/eigenvivek/DiffPose/blob/9a522b04a739334b9ddb89f3a606ab78d80bc6f6/settings.ini#L42).\n", + "To install `DiffPose` and the requirements in [`environment.yml`](https://github.com/eigenvivek/DiffPose/blob/main/environment.yml), run:\n", "\n", "```zsh\n", - "pip install DiffPose\n", + "pip install diffpose\n", "```\n", "\n", - "The source code for the differentiable X-ray renderer is available at [`DiffDRR`](https://github.com/eigenvivek/DiffDRR)." + "The differentiable X-ray renderer that powers the backend of `DiffPose` is available at [`DiffDRR`](https://github.com/eigenvivek/DiffDRR)." ] }, { @@ -44,7 +44,7 @@ "source": [ "## Datasets\n", "\n", - "We evaluate `DiffPose` networks on the following datasets.\n", + "We evaluate `DiffPose` networks on the following open-source datasets:\n", "\n", "| **Dataset** | **Anatomy** | **\\# of Subjects** | **\\# of 2D Images** | **CTs** | **X-rays** | Fiducials |\n", "|----------------------------------------------------------------------------|--------------------|:------------------:|:-------------------:|:-------:|:----------:|:---------:|\n",