Skip to content

Commit b512280

Browse files
committed
reformat readme
1 parent f020d62 commit b512280

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@ OCTET/checkpoints/encoder_256x512.pt
3232

3333
To use OCTET, you will need to instantiate a `Config` object with the desired parameters. The `Config` object should contain the following parameters:
3434

35-
`blobgan_weights`: path to the weights file for the blobGan model
36-
`encoder_weights`: path to the weights file for the image encoder
37-
`decision_model_weights`: path to the weights file for the decision model to be explained
38-
`device`: torch device to use for computation
39-
`output_dir`: directory where generated images will be saved
40-
`real_images`: a boolean indicating whether real images should be used (True) or generated images should be used (False)
41-
`dataset_path`: path to the directory containing the images to use (if `real_images` is True)
42-
`bs`: batch size to use when loading images from the dataset
43-
`num_imgs`: number of images to generate (if `real_images` is False)
35+
* `blobgan_weights`: path to the weights file for the blobGan model
36+
* `encoder_weights`: path to the weights file for the image encoder
37+
* `decision_model_weights`: path to the weights file for the decision model to be explained
38+
* `device`: torch device to use for computation
39+
* `output_dir`: directory where generated images will be saved
40+
* `real_images`: a boolean indicating whether real images should be used (True) or generated images should be used (False)
41+
* `dataset_path`: path to the directory containing the images to use (if `real_images` is True)
42+
* `bs`: batch size to use when loading images from the dataset
43+
* `num_imgs`: number of images to generate (if `real_images` is False)
4444

4545
Once you have created a `Config` object, you can instantiate an OCTET object with `octet = OCTET(config)`. You can then call the following methods on the OCTET object: `octet.invert_and_cf()` that will invert the image to get the latent code and generate the counterfactual explanation.
4646

0 commit comments

Comments
 (0)