Skip to content

Commit

Permalink
docs: added CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
Tan Nian Wei committed Nov 21, 2021
1 parent 6cea00a commit 950fecd
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 1 deletion.
27 changes: 27 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Changelog

## 1.0 - Nov 21, 2021

Since starting this repo in Jul 2021 as a personal project, I believe the codebase is now sufficiently feature-complete and stable to call it a 1.0 release.

### What's new

+ Added support for CLIP guided diffusion (https://github.com/tnwei/vqgan-clip-app/pull/8)
+ Improvements to gallery viewer: added pagination (https://github.com/tnwei/vqgan-clip-app/pull/3), improved webpage responsiveness (https://github.com/tnwei/vqgan-clip-app/issues/9)
+ Minor tweaks to VQGAN-CLIP app, added options to control MSE regularization (https://github.com/tnwei/vqgan-clip-app/pull/4) and TV loss (https://github.com/tnwei/vqgan-clip-app/)
+ Reorganized documentation in README.md and `docs/`

### Transitioning to 1.0 for existing users

Update to 1.0 by running `git pull` from your local copy of this repo. No breaking changes are expected, run results from older versions of the codebase should still show up in the gallery viewer.

However, some new packages are needed to support CLIP guided diffusion. You can follow these steps below instead of setting up the Python environment from scratch:

1. In the repo directory, run `git clone https://github.com/crowsonkb/guided-diffusion`
2. `pip install ./guided-diffusion`
3. `pip install lpips`
4. Download diffusion model checkpoints in `download-diffusion-weights.sh`

## Before Oct 2, 2021

VQGAN-CLIP app and basic gallery viewer implemented.
4 changes: 3 additions & 1 deletion app.py
Original file line number Diff line number Diff line change
Expand Up @@ -477,7 +477,9 @@ def generate_image(
readme_buffer.clear()
st.markdown(" ".join(readme_buffer))

# st.write(description)
with st.expander("Expand for CHANGELOG"):
with open("CHANGELOG.md", "r") as f:
st.markdown(f.read())

if submitted:
# debug_slot.write(st.session_state) # DEBUG
Expand Down
4 changes: 4 additions & 0 deletions diffusion_app.py
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,10 @@ def generate_image(
readme_buffer.clear()
st.markdown(" ".join(readme_buffer))

with st.expander("Expand for CHANGELOG"):
with open("CHANGELOG.md", "r") as f:
st.markdown(f.read())

if submitted:
# debug_slot.write(st.session_state) # DEBUG
status_text.text("Loading weights ...")
Expand Down

0 comments on commit 950fecd

Please sign in to comment.