Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
daniel03c1 authored Dec 18, 2022
1 parent 3fe27e3 commit 3906faf
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Masked Wavelet Representation for Compact Neural Radiance Fields
Daniel Rho*, Byeonghyeon Lee*, Seungtae Nam, Joo Chan Lee, Jong Hwan Ko†, and Eunbyung Park†

[Project Page](https://daniel03c1.github.io/masked_wavelet_nerf/)

Our code is based on NAS-BOWL (https://github.com/apchenstu/TensoRF)

Tested on Ubuntu 18.04 + Pytorch 1.10.2
Expand All @@ -25,18 +27,27 @@ pip install .
python3 train.py --config=configs/chair.txt --use_mask --mask_weight=1e-10 --grid_bit=8 --use_dwt --dwt_level=4
```
- "--config": the name of the config file
- "--datadir": the directory of images
- "--grid_bit": for n-bit quantization (QAT) (only works on grid parameters)
- "--use_mask": in order to use trainable masks, use this option
- "--mask_weight": loss weight to modulate the grid sparsity
- "--use_dwt": to use wavelet coefficients
- "--use_dwt": to use the wavelet transform
- "--dwt_level": the level of wavelet transform
- "--trans_func": the name of wavelet function (default=bior4.4)
- "--trans_func": the name of the wavelet function (default=bior4.4)

More details can be found in "opt.py"


# 2. Model Compression
```bash
python3 compress.py --compress=1 --compress_levelwise=1 --ckpt=PATH_TO_CHECKPOINT
```
- "--ckpt": the saved file name
- "--compress": set to a non-zero value for compression (default=0)
- "--compress_levelwise": set to a non-zero value for level-wise compression (default=0)
- "--decompress": set to a non-zero value for compression (default=0)
- "--decompress_levelwise": you need to use the same value as "compress_levelwise." (default=0)
- "--decompress_and_validatd": whether to evaluate the quality of a decompressed model (default=1)

# 3. Decompression and Evaluation
```bash
Expand Down

0 comments on commit 3906faf

Please sign in to comment.