Skip to content

Commit ad0f0e0

Browse files
committed
Improve README
1 parent d13b911 commit ad0f0e0

File tree

6 files changed

+11
-10
lines changed

6 files changed

+11
-10
lines changed

README.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ SDFEst is a package for pose, scale, and shape estimation using discretized sign
33

44
[Installation](#installation) | [Dataset Preparation](#dataset-preparation) | [Paper Reproduction](#paper-reproduction) | [Code Structure](#code-structure) | [Development](#development) | [Citation](#citation) | [Docs](https://roym899.github.io/sdfest/)
55

6+
![Animation of differentiable renderer.](resources/sdfest_overview.gif)
67

78
## Installation
89

@@ -34,7 +35,7 @@ pip install -r requirements.txt -e .
3435
You need to install Detectron2 manually to run the pipeline with automatic instance segmentation.
3536

3637
Follow the [detectron2 installation guide](https://detectron2.readthedocs.io/en/latest/tutorials/install.html) from there.
37-
Tested with detectron2 0.5 + torch 1.9.0.
38+
Tested with detectron2 0.6 + torch 1.12.0 (and various older versions).
3839

3940
## Dataset Preparation
4041
See below for expected folder structure for each dataset.
@@ -71,14 +72,14 @@ See below for expected folder structure for each dataset.
7172

7273
First, make sure the datasets are in the right format.
7374

74-
### Benchmark Results
75-
Depending on which dataset, you have downloaded you can reproduce the results reported in the paper (using the already trained models) by running the script
76-
```bash
77-
source reproduce_{shapenet,modelnet,redwood}_experiments.sh
78-
```
79-
after that, all results can be found in `./results`.
75+
### Full paper (training and experiments)
76+
See the bash script in `reproduction_scripts/reproduce_paper.sh`.
77+
78+
Evaluation code for REAL275 and REDWOOD75 experiments will be integrated in [cpas_toolbox](https://github.com/roym899/pose_and_shape_evaluation) soon.
79+
80+
<sup>Non-cleaned up version of evaluation code can be found in `icaps_eval` branch.</sup>
8081

81-
### Train Models
82+
### Train Models Only
8283
To train a network for a specific category you need to first train a per-category VAE, and *afterwards* an initialization network.
8384
#### VAE
8485
First we need to convert the ShapeNet meshes to SDFs and optionally filter the dataset. To reproduce the preprocessing of the paper run
@@ -91,7 +92,7 @@ source train_vaes.sh
9192
```
9293
to train the models using the same configuration as used for the paper.
9394

94-
#### Init Network
95+
#### Initialization Network
9596
To train the initialization network we used in our paper, run
9697
```bash
9798
source train_init_networks.sh
@@ -113,7 +114,7 @@ Code is structured into 4 sub-packages:
113114

114115
Differentiable rendering of depth image for signed distance fields.
115116

116-
The signed distance field is assumed to be voxelized and it's pose is given by a x, y, z in the camera frame, a quaternion describing its orientation and a scale parameter describing its size. This module provides the derivative with respect to the signed distance values, and the full pose description (position, orientation, scale).
117+
The signed distance field is assumed to be voxelized and its pose is given by a x, y, z in the camera frame, a quaternion describing its orientation and a scale parameter describing its size. This module provides the derivative with respect to the signed distance values, and the full pose description (position, orientation, scale).
117118

118119
#### Generating compile_commands.json
119120
<sup>General workflow for PyTorch extensions (only tested for JIT, probably similar otherwise)</sup>
File renamed without changes.
File renamed without changes.

resources/sdfest_overview.gif

2.3 MB
Loading

0 commit comments

Comments
 (0)