Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nmichlo committed Jul 28, 2021
1 parent 24e08b4 commit 8c0005b
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,9 @@ are not available from `pip install`.

## Features

Disent includes implementations of modules, metrics and datasets
from various papers. As well as many custom experimental frameworks.
Disent includes implementations of modules, metrics and
datasets from various papers. Please note that items marked
with a "🧵" are introduced in and are unique to disent!

### Frameworks
- **Unsupervised**:
Expand Down Expand Up @@ -181,6 +182,13 @@ low-memory disk-based access.
+ SmallNORB
+ Shapes3D

- **Ground Truth Synthetic**:
+ 🧵 XYObject: *A simplistic version of dSprites with a single square.*

<p align="center">
<img width="384" src="docs/img/xy-object-traversal.png" alt="XYObject Dataset Factor Traversals">
</p>

#### Input Transforms + Input/Target Augmentations

- Input based transforms are supported.
Expand Down Expand Up @@ -290,6 +298,9 @@ a defaults list with entries corresponding to yaml configuration
files (config options) in the subfolders (config groups) in
`experiment/config/<config_group>/<option>.yaml`.

<details><summary><b>Config Defaults Example</b></summary>
<p>

```yaml
defaults:
# system
Expand All @@ -312,6 +323,9 @@ defaults:
...
```

</p>
</details>

Easily modify any of these values to adjust how the basic experiment
will be run. For example, change `framework: adavae` to `framework: betavae`, or
change the dataset from `xyobject` to `shapes3d`. Add new options by adding new
Expand Down
Binary file added docs/img/xy-object-traversal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8c0005b

Please sign in to comment.