lycoris-lora 3.0.0.dev15__tar.gz → 3.0.0.dev16__tar.gz

lycoris_lora-3.0.0.dev16/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.1
+Name: lycoris_lora
+Version: 3.0.0.dev16
+Summary: Lora beYond Conventional methods, Other Rank adaptation Implementations for Stable diffusion
+Home-page: https://github.com/KohakuBlueleaf/LyCORIS
+Author: Shih-Ying Yeh(KohakuBlueLeaf), Yu-Guan Hsieh, Zhidong Gao
+Author-email: apolloyeh0123@gmail.com
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: GPU :: NVIDIA CUDA :: 11.8
+Classifier: Environment :: GPU :: NVIDIA CUDA :: 12
+Classifier: Environment :: GPU :: NVIDIA CUDA :: 12 :: 12.1
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+License-File: LICENSE.md
+Requires-Dist: torch
+Requires-Dist: einops
+Requires-Dist: toml
+Requires-Dist: tqdm

{lycoris_lora-3.0.0.dev15 → lycoris_lora-3.0.0.dev16}/README.md

@@ -1,6 +1,10 @@
+
+![pypi](https://img.shields.io/pypi/v/lycoris-lora.svg)
+![versions](https://img.shields.io/pypi/pyversions/lycoris-lora.svg)
+
 # LyCORIS - Lora beYond Conventional methods, Other Rank adaptation Implementations for Stable diffusion. (ICLR'24)
 
-![banner image](docs/images/banner.png)
+![banner image](docs/images/banner2.png)
 
 A project that implements different parameter-efficient fine-tuning algorithms for Stable Diffusion.
 
@@ -20,21 +24,21 @@ Please check [List of Implemented Algorithms](docs/Algo-List.md) and [Guidelines
 
 A simple comparison of some of these methods are provided below (to be taken with a grain of salt)
 
-|                       | Full | LoRA | LoHa | LoKr low factor | LoKr high factor $^+$ |
-| --------------------- | ---- | ---- | ---- | --------------- | ---------------- |
-| Fidelity              | ★   | ●   | ▲   | ◉              | ▲               |
-| Flexibility $^*$     | ★   | ●   | ◉   | ▲              | ● $^†$        |
-| Diversity             | ▲   | ◉   | ★   | ●              | ★               |
-| Size                  | ▲   | ●   | ●   | ●              | ★               |
-| Training Speed Linear | ★   | ●   | ●   | ★              | ★               |
-| Training Speed Conv   | ●   | ★   | ▲   | ●              | ●               |
+|                       | Full | LoRA | LoHa | LoKr low factor | LoKr high factor$^+$ |
+| --------------------- | ---- | ---- | ---- | --------------- | ---------------------- |
+| Fidelity              | ★   | ●   | ▲   | ◉              | ▲                     |
+| Flexibility$^*$     | ★   | ●   | ◉   | ▲              | ●$^†$              |
+| Diversity             | ▲   | ◉   | ★   | ●              | ★                     |
+| Size                  | ▲   | ●   | ●   | ●              | ★                     |
+| Training Speed Linear | ★   | ●   | ●   | ★              | ★                     |
+| Training Speed Conv   | ●   | ★   | ▲   | ●              | ●                     |
 
 ★ > ◉ > ● > ▲
 [> means better and smaller size is better]
 
-$^+$ Usually we take `factor <= 0.5 * sqrt(dim)` as low factor and `factor >= sqrt(dim` as high factor. For example, factor<=8 for SD1.x/SD2.x/SDXL can be seen as low factor, and, factor>=16 can be seen as high factor. <br>
-$^*$ Flexibility means anything related to generating images not similar to those in the training set, and combination of multiple concepts, whether they are trained together or not <br>
-$^†$ It may become more difficult to switch base model or combine multiple concepts in this situation <br>
+$^+$ Usually we take `factor <= 0.5 * sqrt(dim)` as low factor and `factor >= sqrt(dim` as high factor. For example, factor<=8 for SD1.x/SD2.x/SDXL can be seen as low factor, and, factor>=16 can be seen as high factor. `<br>`
+$^*$ Flexibility means anything related to generating images not similar to those in the training set, and combination of multiple concepts, whether they are trained together or not `<br>`
+$^†$ It may become more difficult to switch base model or combine multiple concepts in this situation `<br>`
 
 **The actual performance may vary depending on the datasets, tasks, and hyperparameters used. It is recommended to experiment with different settings to achieve optimal results.**
 
@@ -66,7 +70,7 @@ However, newer model types may not always be supported. If you encounter this is
 There are three different ways to train LyCORIS models.
 
 - With [kohya-ss/sd-scripts](https://github.com/kohya-ss/sd-scripts) (see a list of compatible graphical interfaces and colabs at the end of the section)
-- With [HCP-Diffusion](https://github.com/IrisRainbowNeko/HCP-Diffusion)
+- With [Naifu-Diffusion](https://github.com/Mikubill/naifu)
 - With your own script by using LyCORIS as standalone wrappers for **ANY** pytorch modules.
 
 In any case, please install this package in the corresponding virtual environment. You can either install it
@@ -159,9 +163,11 @@ forward_with_lyco = your_model(x)
 You can check my [HakuPhi](https://github.com/KohakuBlueleaf/HakuPhi) project to see how I utilize LyCORIS to finetune the Phi-1.5 models.
 
 #### Other method
+
 After LyCORIS3.0.0, Parametrize API and Functional API have been added, which provide more different ways on utilizing LyCORIS library.
 
-Check [xxx] for more informations.
+Check API reference for more informations.
+You can also take the [test suites](test/) as a kind of examples.
 
 #### Bitsandbytes support
 
@@ -250,44 +256,61 @@ See [docs/Conversion-scripts.md](docs/Conversion-scripts.md) for more informatio
 
 For full log, please see [Change.md](Change.md)
 
-## 2024/03/15 update to 2.2.0 - QLyCORIS and DoRA
+### 2024/06/xx update to 3.0.0 - Brand New Functional API, Parametrize API and Module API
+
+#### The reasons of 3.0.0
+
+We reconstruct the whole library with new Class definition and brand new Functional API system.
 
-#### New Algo
+We also removed lot of redundant/unused modules.
 
-* DoRA
-  * Ref: [DoRA: Weight-Decomposed Low-Rank Adaptation](https://github.com/KohakuBlueleaf/LyCORIS)
-* Weight decompose for LoHa and LoKr. (A.K.A DoHa/DoKr)
-  * DoRA/DoHa/DoKr will require smaller Learning rate!
+Since the whole library are changed significantly. We decide to call it 3.0.0 as a new major version.
 
-#### New Features
+#### Major Changes
 
-* Support "bypass" (a.k.a. adapter) mode for LoHa/LoKr/OFT/BOFT
-  * LoHa will require 2xFLOPs since we rebuild full diff weight and then do one more forward.
-  * LoKr, OFT, BOFT should be more efficient than LoHa in bypass mode.
-* Support [bnb 8bit/4bit Linear layer](https://github.com/TimDettmers/bitsandbytes) (a.k.a. QLyCORIS) with LoHa/LoKr/OFT/BOFT.
-  * This will force module to enable bypass mode.
+* New Module API
+* Add Parametrize API
+* Add Functional API
+  * LoCon/LoHa/LoKr/Diag-OFT/BOFT only.
+* Remove optional deps from install_requires
+* Remove lot of redundant/deprecated modules
+* Better testing
+* HunYuan DiT Support ([PR](https://github.com/kohya-ss/sd-scripts/pull/1378) in kohya-ss/sd-scripts)
 
-#### Fixes, slight changes
+#### Full change log
 
-* Refine some details about code quality. Based on the report from GitRoll. (Thx you gitroll!)
-* Remove redundant calculation in BOFT
-* rank_dropout has been removed from OFT/BOFT temporarily untill we ensure how to apply it.
-* Fix bugs in lokr when `lokr_w1_a` not exist.
-* Fix bugs in conversion scritps.
+##### New Features
+
+* LyCORIS now have consistent API for different algorithm like `bypass_forward_diff` or `get_diff_weight` method. Developers of other project can utilize these API to do more tricks or integrate LyCORIS into their framework more easily.
+* LyCORIS now have parametrize API which utilize `torch.nn.utils.parametrize.register_parametrization` to directly patch individual parameters. Which can be useful for MHA layer or other tricky modules.
+  * Currently only support 2~5D tensors. And LyCORIS will pretend these weights are weight of Linear/Conv1,2,3D then send it into LyCORIS modules
+  * More native implementation or more detailed control will be added in the future.
+* LyCORIS now have functional API. Developers who prefer functional more than Module things can utilize this feature.
+  * Functional API also allow developers who don't want to introduce new dependencies. Just copy-paste the source code and utilizing it. (with Apache-2 License, directly copy-paste is totally allowed)
+* Add support for Conv1d and Conv3d module on LoCon/LoHa/LoKr/Full/OFT/BOFT/GLoRA (not All algo in LyCORIS support them, you may receive error when apply unsopported algo), support inherited module (for example: `LoRACompatibleConv` or `LoRACompatibleLinear` from [`huggingface/diffusers`](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/lora.py))
+* HunYuan DiT support.
+
+##### Improvements, Fixes, Slight Changes
+
+* Drop dependencies related to kohya-ss/sd-scripts:
+  * We now take kohya-ss/sd-scripts as optional dependency
+  * Which means `transformers`, `diffusers` and anything related to kohya are all optional deps now.
+* The definition of dropout and rank_dropout in each algorithm are changed. Since some concept of original rank_dropout in the lora of kohya-ss/sd-script is hard to applied to other algorithm. We can only design the dropout for each module seperatedly.
+* `apply_max_norm` issue are all fixed.
+* DyLoRA, (IA)^3, GLoRA are all rewritten and support Linear/Conv1,2,3d.
+* (IA)^3, GLoRA, Diag-OFT, BOFT are supported in `create_lycoris_from_weights`
+  * `lycoris.kohya.create_network_from_weights` also support them as well.
+* Fix wrong implementation of BOFT.
+* `create_lycoris_from_weights` and `create_network_from_weights` now have correct logging infos.
+* `get_module` and `make_module` are moved into modules' API.
 
 ## Todo list
 
-- [X] Module and Document for using LyCORIS in any other model, Not only SD.
-- [X] Proposition3 in [FedPara](https://arxiv.org/abs/2108.06098)
-  * also need custom backward to save the vram
-- [ ] Low rank + sparse representation
-  - [X] For extraction
-  - [ ] For training
-- [ ] Support more operation, not only linear and conv2d.
-- [X] Configure varying ranks or dimensions for specific modules as needed.
 - [ ] Automatically selecting an algorithm based on the specific rank requirement.
-- [ ] Explore other low-rank representations or parameter-efficient methods to fine-tune either the entire model or specific parts of it.
 - [ ] More experiments for different task, not only diffusion models.
+  - [X] LoKr and LoHa have been proven to be useful for Large Language Model.
+- [ ] Explore other low-rank representations or parameter-efficient methods to fine-tune either the entire model or specific parts of it.
+- [ ] Documentation for whole library.
 
 ## Citation
 

lycoris_lora-3.0.0.dev16/lycoris_lora.egg-info/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.1
+Name: lycoris_lora
+Version: 3.0.0.dev16
+Summary: Lora beYond Conventional methods, Other Rank adaptation Implementations for Stable diffusion
+Home-page: https://github.com/KohakuBlueleaf/LyCORIS
+Author: Shih-Ying Yeh(KohakuBlueLeaf), Yu-Guan Hsieh, Zhidong Gao
+Author-email: apolloyeh0123@gmail.com
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: GPU :: NVIDIA CUDA :: 11.8
+Classifier: Environment :: GPU :: NVIDIA CUDA :: 12
+Classifier: Environment :: GPU :: NVIDIA CUDA :: 12 :: 12.1
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+License-File: LICENSE.md
+Requires-Dist: torch
+Requires-Dist: einops
+Requires-Dist: toml
+Requires-Dist: tqdm

lycoris_lora-3.0.0.dev16/setup.py

@@ -0,0 +1,29 @@
+from setuptools import setup, find_packages
+
+
+setup(
+    name="lycoris_lora",
+    packages=find_packages(),
+    version="3.0.0.dev16",
+    url="https://github.com/KohakuBlueleaf/LyCORIS",
+    description="Lora beYond Conventional methods, Other Rank adaptation Implementations for Stable diffusion",
+    author="Shih-Ying Yeh(KohakuBlueLeaf), Yu-Guan Hsieh, Zhidong Gao",
+    author_email="apolloyeh0123@gmail.com",
+    zip_safe=False,
+    install_requires=["torch", "einops", "toml", "tqdm"],
+    python_requires=">=3.10",
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Environment :: GPU :: NVIDIA CUDA :: 11.8',
+        'Environment :: GPU :: NVIDIA CUDA :: 12',
+        'Environment :: GPU :: NVIDIA CUDA :: 12 :: 12.1',
+        'Intended Audience :: Developers',
+        'Intended Audience :: End Users/Desktop',
+        'License :: OSI Approved :: Apache Software License',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
+        'Programming Language :: Python :: 3.12',
+        'Operating System :: OS Independent',
+    ],
+)

lycoris_lora-3.0.0.dev15/PKG-INFO

@@ -1,13 +0,0 @@
-Metadata-Version: 2.1
-Name: lycoris_lora
-Version: 3.0.0.dev15
-Summary: Lora beYond Conventional methods, Other Rank adaptation Implementations for Stable diffusion
-Home-page: https://github.com/KohakuBlueleaf/LyCORIS
-Author: Shih-Ying Yeh(KohakuBlueLeaf), Yu-Guan Hsieh, Zhidong Gao
-Author-email: apolloyeh0123@gmail.com
-Requires-Python: >=3.10
-License-File: LICENSE.md
-Requires-Dist: torch
-Requires-Dist: einops
-Requires-Dist: toml
-Requires-Dist: tqdm

lycoris_lora-3.0.0.dev15/lycoris_lora.egg-info/PKG-INFO

@@ -1,13 +0,0 @@
-Metadata-Version: 2.1
-Name: lycoris_lora
-Version: 3.0.0.dev15
-Summary: Lora beYond Conventional methods, Other Rank adaptation Implementations for Stable diffusion
-Home-page: https://github.com/KohakuBlueleaf/LyCORIS
-Author: Shih-Ying Yeh(KohakuBlueLeaf), Yu-Guan Hsieh, Zhidong Gao
-Author-email: apolloyeh0123@gmail.com
-Requires-Python: >=3.10
-License-File: LICENSE.md
-Requires-Dist: torch
-Requires-Dist: einops
-Requires-Dist: toml
-Requires-Dist: tqdm

lycoris_lora-3.0.0.dev15/setup.py

@@ -1,15 +0,0 @@
-from setuptools import setup, find_packages
-
-
-setup(
-    name="lycoris_lora",
-    packages=find_packages(),
-    version="3.0.0.dev15",
-    url="https://github.com/KohakuBlueleaf/LyCORIS",
-    description="Lora beYond Conventional methods, Other Rank adaptation Implementations for Stable diffusion",
-    author="Shih-Ying Yeh(KohakuBlueLeaf), Yu-Guan Hsieh, Zhidong Gao",
-    author_email="apolloyeh0123@gmail.com",
-    zip_safe=False,
-    install_requires=["torch", "einops", "toml", "tqdm"],
-    python_requires=">=3.10",
-)