diff --git a/docs/example-workflows/data-collection.md b/docs/example-workflows/data-collection.md index 51471e0..e98d8fb 100644 --- a/docs/example-workflows/data-collection.md +++ b/docs/example-workflows/data-collection.md @@ -40,5 +40,5 @@ This guide assumes you have already setup DROID application software to run on y # Uploading Data -Instructions for uploading data can be found in [this](https://github.com/AlexanderKhazatsky/DROID/tree/main/scripts) readme. +Instructions for uploading data can be found in [this](https://github.com/droid-dataset/droid/tree/main/scripts) readme. diff --git a/docs/example-workflows/evaluating-policies.md b/docs/example-workflows/evaluating-policies.md index dc13c10..9995b9a 100644 --- a/docs/example-workflows/evaluating-policies.md +++ b/docs/example-workflows/evaluating-policies.md @@ -7,7 +7,7 @@ nav_order: 5 # Evaluating Policies -* Run a variant of [this](https://github.com/AlexanderKhazatsky/DROID/blob/main/scripts/evaluation/evaluate_policy.py) file with the desired properties. +* Run a variant of [this](https://github.com/droid-dataset/droid/blob/main/scripts/evaluation/evaluate_policy.py) file with the desired properties. * Make sure to update policy_logdir and model_id with the desired values * Any properties that are added to the variant will be loaded from the training folder values. * It is recommended to start off by evaluating policies in the “Practice” tab for simplicity. diff --git a/docs/example-workflows/example-workflows.md b/docs/example-workflows/example-workflows.md index be03637..c30e2d6 100644 --- a/docs/example-workflows/example-workflows.md +++ b/docs/example-workflows/example-workflows.md @@ -11,8 +11,8 @@ permalink: /docs/example-workflows The goal of the workflow guides is to enable users/developers to operate the DROID platform once both the hardware and software have been configured. Guides within this section cover the following topics: -1. [Teleoperating the Robot](https://alexanderkhazatsky.github.io/DROID/example-workflows/teleoperation.html): a guide on using the Oculus Quest 2 to teleoperate the robot. -2. [Calibration Cameras](https://alexanderkhazatsky.github.io/DROID/example-workflows/calibrating-cameras.html): a guide on calibrating the extrinsic parameter of cameras. -3. [Collecting Data](https://alexanderkhazatsky.github.io/DROID/example-workflows/data-collection.html): a guide on using the GUI to collect task demonstrations. -4. [Training Policies](https://alexanderkhazatsky.github.io/DROID/example-workflows/training-policies.html): a guide on training policies using the DROID. -5. [Evaluating Policies](https://alexanderkhazatsky.github.io/DROID/example-workflows/evaluating-policies.html): a guide on evaluating policies using the DROID. +1. [Teleoperating the Robot](https://droid-dataset.github.io/droid/example-workflows/teleoperation.html): a guide on using the Oculus Quest 2 to teleoperate the robot. +2. [Calibration Cameras](https://droid-dataset.github.io/droid/example-workflows/calibrating-cameras.html): a guide on calibrating the extrinsic parameter of cameras. +3. [Collecting Data](https://droid-dataset.github.io/droid/example-workflows/data-collection.html): a guide on using the GUI to collect task demonstrations. +4. [Training Policies](https://droid-dataset.github.io/droid/example-workflows/training-policies.html): a guide on training policies using the DROID. +5. [Evaluating Policies](https://droid-dataset.github.io/droid/example-workflows/evaluating-policies.html): a guide on evaluating policies using the DROID. diff --git a/docs/example-workflows/teleoperation.md b/docs/example-workflows/teleoperation.md index 9c97b74..17e2189 100644 --- a/docs/example-workflows/teleoperation.md +++ b/docs/example-workflows/teleoperation.md @@ -12,7 +12,7 @@ This guide assumes you have already setup DROID application software to run on y # Teleoperating the Robot * To teleoperate the robot, your oculus controller should be plugged into your laptop, and the permissions prompt should be accepted (done by putting the headset on and clicking “Accept”. Also, the controller has to be in view of the headset cameras. It detects the pose of the handle via infrared stickers on the handle. -* To control the robot, we will use only the right controller. If you would like to use the left controller for teleoperation instead, change [this](https://github.com/AlexanderKhazatsky/DROID/blob/5f2f96b5cf9d95dde67fda21a8ab776683aeeae7/droid/controllers/oculus_controller.py#L16) parameter. +* To control the robot, we will use only the right controller. If you would like to use the left controller for teleoperation instead, change [this](https://github.com/droid-dataset/droid/blob/5f2f96b5cf9d95dde67fda21a8ab776683aeeae7/droid/controllers/oculus_controller.py#L16) parameter. * Teleoperation works by applying the changes to the oculus handle’s pose to the robot gripper’s pose. The trigger on the front of the controller is used to control the gripper. Actions are only applied when the trigger on the side of the controller is being held. * It is important for intuitive control that the controller’s definition of forward is aligned with the direction of the robot. The controller defines “forward” on the first step where the side button of the controller is held. At any point, you can redefine the forward direction by pressing down on the joystick until you hear a click. At some point, try changing the definition of forward to get a better feel for its purpose. * To practice, select `Practice` from the GUI application. diff --git a/docs/example-workflows/training-policies.md b/docs/example-workflows/training-policies.md index 15790a0..b473f6a 100644 --- a/docs/example-workflows/training-policies.md +++ b/docs/example-workflows/training-policies.md @@ -7,7 +7,7 @@ nav_order: 4 # Training Policies -* Run a variant of [this](https://github.com/AlexanderKhazatsky/DROID/blob/main/scripts/training/train_policy.py) file with the desired properties. - * If you are doing a simple BC from images sanity check task, run [this](https://github.com/AlexanderKhazatsky/DROID/blob/main/scripts/training/sanity_check/image_obs.py) file +* Run a variant of [this](https://github.com/droid-dataset/droid/blob/main/scripts/training/train_policy.py) file with the desired properties. + * If you are doing a simple BC from images sanity check task, run [this](https://github.com/droid-dataset/droid/blob/main/scripts/training/sanity_check/image_obs.py) file * If the function of any hyperparameters are unclear, message Sasha to inquire about their utility. diff --git a/docs/hardware-setup/hardware-setup.md b/docs/hardware-setup/hardware-setup.md index f5f342f..e80c52a 100644 --- a/docs/hardware-setup/hardware-setup.md +++ b/docs/hardware-setup/hardware-setup.md @@ -16,15 +16,15 @@ The goal of the hardware guides are to: ### Step 1: Procure Hardware Components -The first step to replicate the DROID platform is to procure the required hardware. In the [shopping list](https://alexanderkhazatsky.github.io/DROID/hardware-setup/shopping-list), we provide an exhaustive list of required components to assemble the platform along with a list of suppliers which you can reference when procuring items. +The first step to replicate the DROID platform is to procure the required hardware. In the [shopping list](https://droid-dataset.github.io/droid/hardware-setup/shopping-list), we provide an exhaustive list of required components to assemble the platform along with a list of suppliers which you can reference when procuring items. ### Step 2: Assemble Hardware Components -Once you have acquired the required hardware components, the [assembly guide](https://alexanderkhazatsky.github.io/DROID/hardware-setup/assembly) will walk you through assembling these components into a functional data collection platform. This includes, mounting the robot, cameras and grippers and a general cable management guide. +Once you have acquired the required hardware components, the [assembly guide](https://droid-dataset.github.io/droid/hardware-setup/assembly) will walk you through assembling these components into a functional data collection platform. This includes, mounting the robot, cameras and grippers and a general cable management guide. ### Final Result -By the end of both guides you should have a platform that resembles the image at the bottom of this page. If/when you get to this point congratulations, you are now ready to progress to the [software setup](https://alexanderkhazatsky.github.io/DROID/docs/software-setup) +By the end of both guides you should have a platform that resembles the image at the bottom of this page. If/when you get to this point congratulations, you are now ready to progress to the [software setup](https://droid-dataset.github.io/droid/docs/software-setup) image diff --git a/docs/index.md b/docs/index.md index c3ac2a4..525b472 100644 --- a/docs/index.md +++ b/docs/index.md @@ -19,11 +19,11 @@ This goal of this documentation site is to enable robotics researchers to: The guides for accomplishing these goals are split into the following high-level sections: -* 🔨 [**Hardware Setup:**](https://alexanderkhazatsky.github.io/DROID/docs/hardware-setup) a list of the required hardware (with links to suppliers) and a guide for assembling the platform. -* 🖥️ [**Software Setup:**](https://alexanderkhazatsky.github.ioDROID/docs/software-setup) guides on configuring device settings and software. -* 📈 [**The DROID Dataset:**](https://alexanderkhazatsky.github.io/DROID/docs/the-droid-dataset) an in-the-wild robot manipulation dataset. -* 🤖 [**Example Workflows:**](https://alexanderkhazatsky.github.io/DROID/docs/example-workflows) tutorials for common workflows (e.g. data collection, policy deployment). -* 📖 [**Contribution Guidelines:**](https://alexanderkhazatsky.github.io/DROID/docs/contribution-guidelines) guidelines for contributing data to DROID. +* 🔨 [**Hardware Setup:**](https://droid-dataset.github.io/droid/docs/hardware-setup) a list of the required hardware (with links to suppliers) and a guide for assembling the platform. +* 🖥️ [**Software Setup:**](https:/droid-dataset.github.io/droid/docs/software-setup) guides on configuring device settings and software. +* 📈 [**The DROID Dataset:**](https://droid-dataset.github.io/droid/docs/the-droid-dataset) an in-the-wild robot manipulation dataset. +* 🤖 [**Example Workflows:**](https://droid-dataset.github.io/droid/docs/example-workflows) tutorials for common workflows (e.g. data collection, policy deployment). +* 📖 [**Contribution Guidelines:**](https://droid-dataset.github.io/droid/docs/contribution-guidelines) guidelines for contributing data to DROID.