diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a127b41 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Junhyoung Ryu + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 34b09e9..dc20f09 100644 --- a/README.md +++ b/README.md @@ -69,11 +69,9 @@ trainer = Trainer(max_epochs=8000, accelerator="auto") trainer.fit(consistency, some_dataloader) ``` -
- ### Push to HF Hub -Just provide your `model_id` and `token`! +Provide your `model_id` and `token` to `Consistency`. ```python consistency = Consistency( @@ -98,8 +96,6 @@ pipeline = DiffusionPipeline.from_pretrained( pipeline().images[0] ``` -
- A complete example can be found in [this **script**](https://github.com/junhsss/consistency-models/blob/main/examples/train.py) or in [this **colab notebook**](https://colab.research.google.com/github/junhsss/consistency-models/blob/main/examples/consistency_models.ipynb). Checkout [this **Wandb workspace**](https://wandb.ai/junhsss/consistency?workspace=user-junhsss) for some experiment results. @@ -108,11 +104,11 @@ Checkout [this **Wandb workspace**](https://wandb.ai/junhsss/consistency?workspa ## Available Models -| model_id | sample_size | -| --------------------------- | ----------- | -| consistency/cifar10-32-demo | 32 | +| model_id | dataset | +| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | +| consistency/cifar10-32-demo | cifar10 | -If you've trained some checkpoints. **Share with us! 🤗** +If you've trained some checkpoints using `consistency`, **share with us! 🤗**