Update docs (#31)

Signed-off-by: Keegan Go <[email protected]>

Author: kggo

README.md

@@ -1,7 +1,7 @@
 # Perception Challenge For Bin-Picking
 
-[![build](https://github.com/Yadunund/ibpc/actions/workflows/build.yaml/badge.svg?branch=main)](https://github.com/Yadunund/ibpc/actions/workflows/build.yaml)
-[![style](https://github.com/Yadunund/ibpc/actions/workflows/style.yaml/badge.svg?branch=main)](https://github.com/Yadunund/ibpc/actions/workflows/style.yaml)
+[![build](https://github.com/Yadunund/bpc/actions/workflows/build.yaml/badge.svg?branch=main)](https://github.com/Yadunund/bpc/actions/workflows/build.yaml)
+[![style](https://github.com/Yadunund/bpc/actions/workflows/style.yaml/badge.svg?branch=main)](https://github.com/Yadunund/bpc/actions/workflows/style.yaml)
 
 For more details on the challenge, [click here](https://bpc.opencv.org/).
 
@@ -60,17 +60,17 @@ Participants are expected to modify the estimator code to implement their soluti
 
 
 ```bash
-mkdir -p ~/ws_ibpc/src
-cd ~/ws_ibpc/src
-git clone https://github.com/Yadunund/ibpc.git
+mkdir -p ~/ws_bpc/src
+cd ~/ws_bpc/src
+git clone https://github.com/Yadunund/bpc.git
 ```
 
 ## Build
 
 ### Build the ibpc_pose_estimator
 
 ```bash
-cd ~/ws_ibpc/src/ibpc
+cd ~/ws_bpc/src/bpc
 docker buildx build -t ibpc:pose_estimator \
     --file ./Dockerfile.estimator \
     --build-arg="MODEL_DIR=models" \
@@ -80,7 +80,7 @@ docker buildx build -t ibpc:pose_estimator \
 ### Build the ibpc_tester
 
 ```bash
-cd ~/ws_ibpc/src/ibpc
+cd ~/ws_bpc/src/bpc
 docker buildx build -t ibpc:tester \
     --file ./Dockerfile.tester \
     .
@@ -95,14 +95,14 @@ docker run --init --rm --net host eclipse/zenoh:1.1.1 --no-multicast-scouting
 ```
 
 ### Run the pose estimator
-We use [rocker](https://github.com/osrf/rocker) to add GPU support to Docker containers. To install rocker, run `pip install rocker` on the host machine. 
+We use [rocker](https://github.com/osrf/rocker) to add GPU support to Docker containers. To install rocker, run `pip install rocker` on the host machine.
 ```bash
 rocker --nvidia --cuda run --network=host ibpc:pose_estimator
 ```
 
 ### Run the tester
 
-> Note: Substitute the <PATH_TO_DATASET> with the location of the IPD dataset you've downloaded.
+> Note: Substitute the <PATH_TO_DATASET> with the directory that contains the [ipd](https://huggingface.co/datasets/bop-benchmark/ipd/tree/main) dataset.
 
 ```bash
 docker run --network=host -e BOP_PATH=/opt/ros/underlay/install/datasets -e SPLIT_TYPE=val -v<PATH_TO_DATASET>:/opt/ros/underlay/install/datasets -it ibpc:tester

ibpc_py/README.md

@@ -1,6 +1,6 @@
-# Industrial Bin Picking Challenge (IBPC)
+# Perception Challenge For Bin-Picking
 
-This is the python entrypoint for the Industrial Bin Picking Challenge
+This is the python entrypoint for the Bin Picking Challenge
 
 ## Usage
 
@@ -22,17 +22,17 @@ Run tests against a dataset
 In a virtualenv
 `pip install ibpc`
 
-Temporary before rocker release of https://github.com/osrf/rocker/pull/317/ 
+Temporary before rocker release of https://github.com/osrf/rocker/pull/317/
 `pip uninstall rocker && pip install git+http://github.com/osrf/rocker.git@console_to_file`
 
 
 ### Nvidia Docker (optoinal)
-Make sure nvidia_docker is installed if you want cuda. 
+Make sure nvidia_docker is installed if you want cuda.
 
 ## Release instructions
 
 ```
 rm -rf dist/*
 python3 -m build --sdist .
 twine upload dist/*
-```
+```