Commit
·
cf2fde0
1
Parent(s):
87afe95
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,63 @@
|
|
| 1 |
---
|
| 2 |
license: openrail
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 3 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
license: openrail
|
| 3 |
+
metrics:
|
| 4 |
+
- accuracy
|
| 5 |
+
- bertscore
|
| 6 |
+
- bleu
|
| 7 |
+
- bleurt
|
| 8 |
+
- brier_score
|
| 9 |
+
- cer
|
| 10 |
+
- character
|
| 11 |
+
- charcut_mt
|
| 12 |
+
- chrf
|
| 13 |
+
- code_eval
|
| 14 |
+
tags:
|
| 15 |
+
- text-to-image
|
| 16 |
+
- sygil-devs
|
| 17 |
+
- Muse
|
| 18 |
+
- Sygil-Muse
|
| 19 |
---
|
| 20 |
+
|
| 21 |
+
# Model Card for Model ID
|
| 22 |
+
|
| 23 |
+
<!-- Provide a quick summary of what the model is/does. -->
|
| 24 |
+
|
| 25 |
+
This model is based in [Muse](https://muse-model.github.io/) and trained using [`lucidrains/muse-maskgit-pytorch`](https://github.com/lucidrains/muse-maskgit-pytorch).
|
| 26 |
+
|
| 27 |
+
# Model Details
|
| 28 |
+
This model is a new model trained from scratch based on [Muse](https://muse-model.github.io/), trained on the [Imaginary Network Expanded Dataset](https://github.com/Sygil-Dev/INE-dataset), with the big advantage of allowing the use of multiple namespaces (labeled tags) to control various parts of the final generation.
|
| 29 |
+
The use of namespaces (eg. “species:seal” or “studio:dc”) stops the model from misinterpreting a seal as the singer Seal, or DC Comics as Washington DC.
|
| 30 |
+
|
| 31 |
+
Note: As of right now, only the first VAE has been trained, we still need to train the Base and Super Resolution VAE for the model to be usable.
|
| 32 |
+
|
| 33 |
+
If you find our work useful, please consider supporting us on [OpenCollective](https://opencollective.com/sygil_dev)!
|
| 34 |
+
|
| 35 |
+
This model is still in its infancy and it's meant to be constantly updated and trained with more and more data as time goes by, so feel free to give us feedback on our [Discord Server](https://discord.gg/UjXFsf6mTu) or on the discussions section on huggingface. We plan to improve it with more, better tags in the future, so any help is always welcome.
|
| 36 |
+
[](https://discord.gg/UjXFsf6mTu)
|
| 37 |
+
|
| 38 |
+
|
| 39 |
+
## Available Checkpoints:
|
| 40 |
+
- #### Stable:
|
| 41 |
+
- No stable version available right now.
|
| 42 |
+
- #### Beta:
|
| 43 |
+
- [vae.175500.pt](https://huggingface.co/Sygil/Sygil-Muse/blob/main/vae.175500.pt): Trained from scratch for 175,500 steps
|
| 44 |
+
|
| 45 |
+
Note: Checkpoints under the Beta section are updated daily or at least 3-4 times a week. This is usually the equivalent of 1-2 training session,
|
| 46 |
+
this is done until they are stable enough to be moved into a proper release, usually every 1 or 2 weeks.
|
| 47 |
+
While the beta checkpoints can be used as they are only the latest version is kept on the repo and the older checkpoints are removed when a new one
|
| 48 |
+
is uploaded to keep the repo clean.
|
| 49 |
+
|
| 50 |
+
## Training
|
| 51 |
+
|
| 52 |
+
**Training Data**:
|
| 53 |
+
The model was trained on the following dataset:
|
| 54 |
+
- [Imaginary Network Expanded Dataset](https://github.com/Sygil-Dev/INE-dataset) dataset.
|
| 55 |
+
|
| 56 |
+
**Hardware and others**
|
| 57 |
+
- **Hardware:** 1 x Nvidia RTX 3050 8GB GPU
|
| 58 |
+
- **Hours Trained:** NaN.
|
| 59 |
+
- **Gradient Accumulations**: 1
|
| 60 |
+
- **Batch:** 1
|
| 61 |
+
- **Learning Rate:** 3e-4
|
| 62 |
+
- **Resolution**: 512 pixels
|
| 63 |
+
- **Total Training Steps:** 175,500
|