Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hanxiao committed Jul 18, 2022
1 parent 3fef2f8 commit cbd0d30
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 5 deletions.
Binary file added .github/spell-check.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/type-hint-colab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/type-hint.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 24 additions & 5 deletions FEATURES.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,24 @@ DiscoArt is synced with the upstream update of original DD notebook. The list be
- Robust persistent storage for the generated images.
- Simpler interface and Pythonic API.

## Spellchecking

Typos in the prompts can lead to suboptimal image generation; and they are often hard to recognize. In DiscoArt, you will see a warning message when you have a typo as follows:

![](.github/spell-check.png)

Artist names and common modifiers (e.g. `dof`, `artstation`) are added into whitelist to avoid the false alarm.

You can change `on_misspelled_token` parameter to enforce auto-correction as well.

## IDE support

When writing DiscoArt applications in PyCharm/VSCode/Jupyter/Google Colab, you will get <kbd>tab</kbd> complete and parameter hinting out of the box.

![](.github/type-hint.png)

![](.github/type-hint-colab.png)

## Scheduling

The following variables can be either scalar variables in the type of bool, float or int; or can be scheduled via the syntax of `[val]*400+[val1]*100+[val2]*500` over 1000 steps.
Expand All @@ -35,21 +53,22 @@ Also:
- `clip_models_schedules` is added to control the scheduling of clip models, the syntax is the same as `cut_overview` but as a bool list `[True]*400+[False]*600`.

## Customized diffusion

Latest diffusion models are automatically synced to local when they become available, there is no need to update the codebase.

![](.github/auto-sync-diffusion.png)

- Support default 512x512, 256x256 diffusion model as well as Pixel Art Diffusion, Watercolor Diffusion, and Pulp SciFi Diffusion models.
- `diffusion_model` and `diffusion_model_config` can be specified load custom diffusion model and override the default diffusion model.

To list all supporteed diffusion models,
To list all supported diffusion models,

```python
from discoart.helper import list_diffusion_models

list_diffusion_models()
```

Latest diffusion models are automatically synced to local when they become available, there is no need to update the codebase.

![](.github/auto-sync-diffusion.png)


## Feature changes
- DiscoArt does not support video generation and `image_prompt` (which was marked as ineffective in DD 5.4).
Expand Down

0 comments on commit cbd0d30

Please sign in to comment.