Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
CuddleSabe authored Dec 19, 2023
1 parent 114a5e0 commit 625c153
Showing 1 changed file with 37 additions and 57 deletions.
94 changes: 37 additions & 57 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,39 @@
# ProjectTemplate-Python

[English](README.md) **|** [简体中文](README_CN.md)   [GitHub](https://github.com/CuddleSabe/VQGAN.git) **|** [Gitee码云](https://github.com/CuddleSabe/VQGAN.git)

# VQGAN
[GitHub](https://github.com/CuddleSabe/VQGAN.git) **|** [Gitee码云](https://github.com/CuddleSabe/VQGAN.git)

## Install


1. [pylint](./github/workflows/pylint.yml)
1. [gitee-repo-mirror](./github/workflow/gitee-repo-mirror.yml) - Support Gitee码云
1. Clone GitHub repo in the [Gitee](https://gitee.com/) website
1. Modify [gitee-repo-mirror](./github/workflow/gitee-repo-mirror.yml)
1. In Github *Settings* -> *Secrets*, add `SSH_PRIVATE_KEY`

## Other Procedures

1. The `description`, `website`, `topics` in the main page
1. Support Chinese documents, for example, `README_CN.md`

## Emoji

[Emoji cheat-sheet](https://github.com/ikatyang/emoji-cheat-sheet)

| Emoji | Meaning |
| :--- | :---: |
| :rocket: | Used for [BasicSR](https://github.com/xinntao/BasicSR) Logo |
| :sparkles: | Features |
| :zap: | HOWTOs |
| :wrench: | Installation / Usage |
| :hourglass_flowing_sand: | TODO list |
| :turtle: | Dataset preparation |
| :computer: | Commands |
| :european_castle: | Model zoo |
| :memo: | Designs |
| :scroll: | License and acknowledgement |
| :earth_asia: | Citations |
| :e-mail: | Contact |
| :m: | Models |
| :arrow_double_down: | Download |
| :file_folder: | Datasets |
| :chart_with_upwards_trend: | Curves|
| :eyes: | Screenshot |
| :books: |References |

## Useful Image Links

<img src="https://colab.research.google.com/assets/colab-badge.svg" height="28" alt="google colab logo"> Google Colab Logo <br>
<img src="https://upload.wikimedia.org/wikipedia/commons/8/8d/Windows_darkblue_2012.svg" height="28" alt="google colab logo"> Windows Logo <br>
<img src="https://upload.wikimedia.org/wikipedia/commons/3/3a/Logo-ubuntu_no%28r%29-black_orange-hex.svg" alt="Ubuntu" height="24"> Ubuntu Logo <br>

## Other Useful Tips

1. `More` drop-down menu
<details>
<summary>More</summary>
<ul>
<li>Nov 19, 2020. Set up ProjectTemplate-Python.</li>
</ul>
</details>
'''python
git clone https://github.com/CuddleSabe/VQGAN.git
cd VQGAN
python setup.py develop
'''

## Download
[Baidu](https://pan.baidu.com/s/1-LhE70tNA0YX38YUUkDi4A?pwd=fxvu) 提取码:fxvu
[Google](https://drive.google.com/drive/folders/1tdxILPP8MIBROB79RwGuA1Bv-CymRmt7?usp=share_link)

## Train
1. ''' bash
vim options/train_vqvae.yml
'''
2. ''' bash
sh train_vqvae.sh
'''
3. '''bash
vim options/train_vqgan.yml
'''
5. '''bash
sh train_vqgan.sh
'''
## Inference
'''python
python inference_vqvae.py
'''

## Idea

<img width="1123" alt="截屏2023-12-19 16 43 59" src="https://github.com/CuddleSabe/VQGAN/assets/61224076/9e526051-b3a7-4d34-b75d-10e4a4032900">

<img width="1155" alt="截屏2023-12-19 16 44 25" src="https://github.com/CuddleSabe/VQGAN/assets/61224076/f8a137a4-9400-4cba-9c71-d4fdd169c866">

<img width="1321" alt="截屏2023-12-19 16 44 52" src="https://github.com/CuddleSabe/VQGAN/assets/61224076/4a5206ee-9783-4e65-914b-599c5c926f5a">

0 comments on commit 625c153

Please sign in to comment.