Skip to content

Commit 1f22bb1

Browse files
committed
Directory name
1 parent 0bcf5ea commit 1f22bb1

File tree

6 files changed

+11
-11
lines changed

6 files changed

+11
-11
lines changed

Documentation/0_ros_setup.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This page provides steps on how to manually set up a catkin workspace for the Pose Estimation tutorial.
44

5-
1. Navigate to the `object_pose_estimation/` directory of this downloaded repository. This directory will be used as the ROS catkin workspace.
5+
1. Navigate to the root `Object-Pose-Estimation/` directory of this downloaded repository. This directory will be used as the ROS catkin workspace.
66

77
2. Copy or download this directory to your ROS operating system if you are doing ROS operations in another machine, VM, or container.
88

Documentation/3_data_collection_model_training.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Now its time to train our deep learning model! We've provided the model training
6060

6161
This step can take a long time if your computer doesn't have GPU support (~5 days on CPU). Even with a GPU, it can take around ~10 hours. We have provided an already trained model as an alternative to waiting for training to complete. If you would like to use this provided model, you can proceed to [Part 4](4_pick_and_place.md).
6262

63-
1. Navigate to the `tutorials/object_pose_estimation/Model` directory.
63+
1. Navigate to the `Object-Pose-Estimation/Model` directory.
6464

6565
### Requirements
6666

@@ -110,7 +110,7 @@ log_dir_system: /Users/jonathan.leban/Documents/models
110110
### Training the model
111111
Now its time to train our deep learning model!
112112

113-
6. If you are not already in the `tutorials/object_pose_estimation/Model` directory, navigate there.
113+
6. If you are not already in the `Object-Pose-Estimation/Model` directory, navigate there.
114114

115115
7. Enter the following command to start training:
116116
```bash
@@ -131,7 +131,7 @@ However, first we need to specify a few settings in our config file.
131131

132132
8. In [config.yaml](../Model/config.yaml), under `checkpoint`, you need to set the argument `log_dir_checkpoint` to the path where you have saved your newly trained model.
133133

134-
9. If you are not already in the `tutorials/object_pose_estimation/Model` directory, navigate there.
134+
9. If you are not already in the `Object-Pose-Estimation/Model` directory, navigate there.
135135

136136
10. To start the evaluation run, enter the following command:
137137
```bash

Documentation/4_pick_and_place.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Building this Docker container will install the necessary packages for this tuto
6363
<img src="Images/4_docker_daemon.png" height=500/>
6464
</p>
6565
66-
2. In the terminal, ensure the current location is at the root of the `object_pose_estimation` directory. Build the provided ROS Docker image as follows:
66+
2. In the terminal, ensure the current location is at the root of the `Object-Pose-Estimation` directory. Build the provided ROS Docker image as follows:
6767
6868
```bash
6969
docker build -t unity-robotics:pose-estimation -f docker/Dockerfile .
@@ -90,7 +90,7 @@ source devel/setup.bash
9090
9191
The ROS workspace is now ready to accept commands!
9292
93-
>Note: The Docker-related files (Dockerfile, bash scripts for setup) are located in `PATH-TO-object_pose_estimation/docker`.
93+
>Note: The Docker-related files (Dockerfile, bash scripts for setup) are located in `Object-Pose-Estimation/docker`.
9494
9595
---
9696

Documentation/quick_demo_full.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ git clone --recurse-submodules https://github.com/Unity-Technologies/Object-Pose
2626

2727
## <a name='setup'>Setup</a>
2828

29-
1. Open the completed project. In the Unity Hub, click the `Add` button, and select `tutorials/object_pose_estimation/PoseEstimationDemoProject` from inside the file location where you cloned this repo.
29+
1. Open the completed project. In the Unity Hub, click the `Add` button, and select `Object-Pose-Estimation/PoseEstimationDemoProject` from inside the file location where you cloned this repo.
3030

3131
2. Open the scene. Go to `Assets > Scenes` and double click on `TutorialPoseEstimation`.
3232

@@ -38,7 +38,7 @@ git clone --recurse-submodules https://github.com/Unity-Technologies/Object-Pose
3838

3939
## Add the Pose Estimation Model
4040

41-
In your `object_pose_estimation` folder, you should have a `ROS` folder. Inside that folder you should have a `src` folder and inside that one 5 folders: `moveit_msgs`, `robotiq`, `ros_tcp_endpoint`, `universal_robot` and `ur3_moveit`.
41+
In your root `Object-Pose-Estimation` folder, you should have a `ROS` folder. Inside that folder you should have a `src` folder and inside that one 5 folders: `moveit_msgs`, `robotiq`, `ros_tcp_endpoint`, `universal_robot` and `ur3_moveit`.
4242

4343
1. Download the [pose estimation model](https://github.com/Unity-Technologies/Unity-Robotics-Hub/releases/download/Pose-Estimation/UR3_single_cube_model.tar) we have trained.
4444

@@ -57,7 +57,7 @@ We have provided a Docker container to get you up and running quickly.
5757
<img src="Images/4_docker_daemon.png" height=400/>
5858
</p>
5959

60-
2. In the terminal, ensure the current location is at the root of the `object_pose_estimation` directory. Build the provided ROS Docker image as follows:
60+
2. In the terminal, ensure the current location is at the root of the `Object-Pose-Estimation` directory. Build the provided ROS Docker image as follows:
6161

6262
```bash
6363
docker build -t unity-robotics:pose-estimation -f docker/Dockerfile .

Documentation/quick_demo_train.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ git clone https://github.com/Unity-Technologies/Unity-Robotics-Hub.git
2525

2626
2. [Install Unity `2020.2.*`.](install_unity.md)
2727

28-
3. Open the completed project. To do so, open Unity Hub, click the `Add` button, and select `PoseEstimationDemoProject` from the `Unity-Robotics-Hub/tutorials/object_pose_estimation/` folder.
28+
3. Open the completed project. To do so, open Unity Hub, click the `Add` button, and select `PoseEstimationDemoProject` from the root `Object-Pose-Estimation` folder.
2929

3030
## <a name='setup'>Setup</a>
3131

Model/documentation/running_on_docker.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Before creating the Docker image, you need to be sure your Docker settings are c
2121

2222
The first step is to build the Docker image.
2323

24-
* **Action**: Open a new terminal and navigate to the `Unity-Robotics-Hub/tutorials/object_pose_estimation/Model` folder. Then run the command to build your docker image, and name it `pose_estimation`:
24+
* **Action**: Open a new terminal and navigate to the `Object-Pose-Estimation/Model` folder. Then run the command to build your docker image, and name it `pose_estimation`:
2525
```bash
2626
docker build -t pose_estimation .
2727
```

0 commit comments

Comments
 (0)