Skip to content

Add code blocks for command line examples in README #4

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.

Sign up for GitHub

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

Open
KiWeng wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add code blocks for command line examples in README #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,23 @@ These datasets can be generated from [/benchmarking](https://github.com/Bashivan
- [Install graphiz on your machine](https://pygraphviz.github.io/documentation/stable/install.html)
### Poetry
#### Install Poetry
curl -sSL https://install.python-poetry.org | python3 -

```shell
curl -sSL https://install.python-poetry.org | python3 -
```

### Conda + Poetry
#### Create conda python environment
conda create --name iwisdm python=3.11

```shell
conda create --name iwisdm python=3.11
```

#### Install packages
poetry install

```shell
poetry install
```

### ShapeNet Subset
A large-scale repository of shapes represented by 3D CAD models of objects [(Chang et. al. 2015)](https://arxiv.org/abs/1512.03012).
Expand Down
25 changes: 17 additions & 8 deletions benchmarking/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,26 @@
# Benchmarking Run Parameters

### Single Frame Example
python create_bench.py --stim_dir='../data/shapenet_handpicked' --tasks_dir='./tasks/single_cat' --trials_dir='temp/single_cat'
--config_path='configs/single_frame_cat.json' --min_len=1 --max_len=1 --n_trials=100 --n_tasks=10 --features='cat' --min_joint_ops=0 --max_joint_ops=0 --force_balance


```shell
python create_bench.py --stim_dir='../data/shapenet_handpicked' --tasks_dir='./tasks/single_cat' --trials_dir='temp/single_cat' --config_path='configs/single_frame_cat.json' --min_len=1 --max_len=1 --n_trials=100 --n_tasks=10 --features='cat' --min_joint_ops=0 --max_joint_ops=0 --force_balance
```

### Low Complexity Example:
python create_bench.py --stim_dir='../data/shapenet_handpicked' --tasks_dir='./tasks/low_all' --trials_dir='temp/low_all'
--config_path='configs/low_complexity_all.json' --min_len=6 --max_len=6 --n_trials=100 --n_tasks=100 --features='all' --min_joint_ops=1 --max_joint_ops=1 --force_balance

```shell
python create_bench.py --stim_dir='../data/shapenet_handpicked' --tasks_dir='./tasks/low_all' --trials_dir='temp/low_all' --config_path='configs/low_complexity_all.json' --min_len=6 --max_len=6 --n_trials=100 --n_tasks=100 --features='all' --min_joint_ops=1 --max_joint_ops=1 --force_balance
```

### Medium Complexity Example:
python create_bench.py --stim_dir='../data/shapenet_handpicked' --tasks_dir='./tasks/medium_all' --trials_dir='temp/medium_all'
--config_path='configs/medium_complexity_all.json' --min_len=8 --max_len=8 --n_trials=100 --n_tasks=100 --features='all' --min_joint_ops=1 --max_joint_ops=1 --force_balance

```shell
python create_bench.py --stim_dir='../data/shapenet_handpicked' --tasks_dir='./tasks/medium_all' --trials_dir='temp/medium_all' --config_path='configs/medium_complexity_all.json' --min_len=8 --max_len=8 --n_trials=100 --n_tasks=100 --features='all' --min_joint_ops=1 --max_joint_ops=1 --force_balance
```

### High Complexity Example:
python create_bench.py --stim_dir='../data/shapenet_handpicked' --tasks_dir='./tasks/high_all' --trials_dir='temp/high_all'
--config_path='configs/high_complexity_all.json' --min_len=9 --max_len=9 --n_trials=100 --n_tasks=100 --features='all' --min_joint_ops=1 --max_joint_ops=2 --force_balance --non_bool_actions

```shell
python create_bench.py --stim_dir='../data/shapenet_handpicked' --tasks_dir='./tasks/high_all' --trials_dir='temp/high_all' --config_path='configs/high_complexity_all.json' --min_len=9 --max_len=9 --n_trials=100 --n_tasks=100 --features='all' --min_joint_ops=1 --max_joint_ops=2 --force_balance --non_bool_actions
```