Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix links and commands in README.md and scripts/README.md #10

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

- [x] March 29th: Dataset Released!
- [x] July 3rd: Scanned CAD [Available](Dataset.md#model-table-with-download-links)
- [x] July 3rd: Code for [downloading](./scripts/dataset/README.md) and [visualization data](./render.ipynb)
- [x] July 3rd: Code for [downloading](./scripts/README.md) and [visualization data](./demo_render.ipynb)
- [x] August 15th: Code for Robot Consistency Evaluation Method
- [ ] February 2025: Leaderboard for submitting results on test images

Expand All @@ -35,7 +35,7 @@

In the repo you can find the evaluation dataset as well as links to relevant cad models

Please use our scripts to download/extract datasets and cad models in [scripts/dataset](./scripts/dataset/README.md)
Please use our scripts to download/extract datasets and cad models in [scripts/](./scripts/README.md)

Dataset and CAD model descriptions along with download links are available [here](Dataset.md)

Expand Down
14 changes: 7 additions & 7 deletions scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export ID=dataset_basket_0
export CAMERA=Basler-LR
export FOLDER=./datasets

bash scripts/dataset/get_dataset.sh $ID $CAMERA $FOLDER
bash scripts/get_dataset.sh $ID $CAMERA $FOLDER
```

## Option 3: Python CLI
Expand All @@ -23,30 +23,30 @@ Has options to download one or more datasets to specified folder, option to extr
- Install the `intrinsic-ipd-cli`:
- From source:
1. Clone this repo
2. Install `pip -e .`
2. Install `pip install -e .`
- Via pip: (not yet available!!!)
1. `pip install ipd`

Should have the download cli available via `ipd-cli` command.

- To download and extract all datasets:
```bash
intrinsic-ipd-cli --id ALL --camera ALL --folder ./datasets --extract
intrinsic-ipd-cli --id ALL --camera ALL --root ./datasets --extract
```

- To download and extract one dataset:
```bash
intrinsic-ipd-cli --id dataset_basket_1 --camera Basler-LR --folder ./datasets --extract
intrinsic-ipd-cli --id dataset_basket_1 --camera Basler-LR --root ./datasets --extract
```

- To download and extract all cameras for one dataset:
```bash
intrinsic-ipd-cli --id dataset_basket_1 --camera ALL --folder ./datasets --extract
intrinsic-ipd-cli --id dataset_basket_1 --camera ALL --root ./datasets --extract
```

- To download and extract all datasets for one camera:
```bash
intrinsic-ipd-cli --id ALL --camera Basler-LR --folder ./datasets --extract
intrinsic-ipd-cli --id ALL --camera Basler-LR --root ./datasets --extract
```

- All command line options:
Expand All @@ -59,6 +59,6 @@ Has options to download one or more datasets to specified folder, option to extr
Supply a camera id or or 'ALL' to download all cameras for the specified dataset
--id {ALL, dataset_basket_0, dataset_basket_1,..., dataset_texturedbg_3}
Supply a dataset id or 'ALL' to download all datasets for specified camera
--folder FOLDER Folder to download/extract the datasets to
--root FOLDER Folder to download/extract the datasets to
--extract Flag to extract the downloaded dataset(s)
```
4 changes: 2 additions & 2 deletions src/intrinsic_ipd/download_cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ def main():
for dataset in selected_datasets:
zip_path = download_dataset(dataset, camera, args.root)
if args.extract and zip_path:
extract(zip_path)
extract(zip_path, args.root)

#download the cad_models
print(f"Downloading cad models to {args.folder}/models")
print(f"Downloading cad models to {args.root}/models")
download_cads(args.root)

if __name__ == "__main__":
Expand Down