Skip to content

Commit dfa3079

Browse files
committed
update readme
1 parent d30ebb2 commit dfa3079

File tree

2 files changed

+54
-44
lines changed

2 files changed

+54
-44
lines changed

README-ja.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,3 +111,47 @@ Conv2d 3x3への拡大は [cloneofsimo氏](https://github.com/cloneofsimo/lora)
111111

112112
[BLIP](https://github.com/salesforce/BLIP): BSD-3-Clause
113113

114+
## その他の情報
115+
116+
### LoRAの名称について
117+
118+
`train_network.py` がサポートするLoRAについて、混乱を避けるため名前を付けました。ドキュメントは更新済みです。以下は当リポジトリ内の独自の名称です。
119+
120+
1. __LoRA-LierLa__ : (LoRA for __Li__ n __e__ a __r__ __La__ yers、リエラと読みます)
121+
122+
Linear 層およびカーネルサイズ 1x1 の Conv2d 層に適用されるLoRA
123+
124+
2. __LoRA-C3Lier__ : (LoRA for __C__ olutional layers with __3__ x3 Kernel and __Li__ n __e__ a __r__ layers、セリアと読みます)
125+
126+
1.に加え、カーネルサイズ 3x3 の Conv2d 層に適用されるLoRA
127+
128+
デフォルトではLoRA-LierLaが使われます。LoRA-C3Lierを使う場合は `--network_args``conv_dim` を指定してください。
129+
130+
<!--
131+
LoRA-LierLa は[Web UI向け拡張](https://github.com/kohya-ss/sd-webui-additional-networks)、またはAUTOMATIC1111氏のWeb UIのLoRA機能で使用することができます。
132+
133+
LoRA-C3Lierを使いWeb UIで生成するには拡張を使用してください。
134+
-->
135+
136+
### 学習中のサンプル画像生成
137+
138+
プロンプトファイルは例えば以下のようになります。
139+
140+
```
141+
# prompt 1
142+
masterpiece, best quality, (1girl), in white shirts, upper body, looking at viewer, simple background --n low quality, worst quality, bad anatomy,bad composition, poor, low effort --w 768 --h 768 --d 1 --l 7.5 --s 28
143+
144+
# prompt 2
145+
masterpiece, best quality, 1boy, in business suit, standing at street, looking back --n (low quality, worst quality), bad anatomy,bad composition, poor, low effort --w 576 --h 832 --d 2 --l 5.5 --s 40
146+
```
147+
148+
`#` で始まる行はコメントになります。`--n` のように「ハイフン二個+英小文字」の形でオプションを指定できます。以下が使用可能できます。
149+
150+
* `--n` Negative prompt up to the next option.
151+
* `--w` Specifies the width of the generated image.
152+
* `--h` Specifies the height of the generated image.
153+
* `--d` Specifies the seed of the generated image.
154+
* `--l` Specifies the CFG scale of the generated image.
155+
* `--s` Specifies the number of steps in the generation.
156+
157+
`( )``[ ]` などの重みづけも動作します。

README.md

Lines changed: 10 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -137,15 +137,16 @@ The majority of scripts is licensed under ASL 2.0 (including codes from Diffuser
137137

138138
## Change History
139139

140-
### Mar XX, 2024 / 2024/3/XX: v0.8.6
140+
### Apr 7, 2024 / 2024-04-07: v0.8.6
141141

142142
#### Highlights
143143

144144
- The dependent libraries are updated. Please see [Upgrade](#upgrade) and update the libraries.
145145
- Especially `imagesize` is newly added, so if you cannot update the libraries immediately, please install with `pip install imagesize==1.4.1` separately.
146146
- `bitsandbytes==0.43.0`, `prodigyopt==1.0`, `lion-pytorch==0.0.6` are included in the requirements.txt.
147+
- `bitsandbytes` no longer requires complex procedures as it now officially supports Windows.
147148
- Also, the PyTorch version is updated to 2.1.2 (PyTorch does not need to be updated immediately). In the upgrade procedure, PyTorch is not updated, so please manually install or update torch, torchvision, xformers if necessary (see [Upgrade PyTorch](#upgrade-pytorch)).
148-
- When logging to wandb is enabled, the entire command line is exposed. Therefore, it is recommended to write the API key of wandb and the token of HuggingFace in the configuration file (`.toml`). Thanks to bghira for raising the issue.
149+
- When logging to wandb is enabled, the entire command line is exposed. Therefore, it is recommended to write wandb API key and HuggingFace token in the configuration file (`.toml`). Thanks to bghira for raising the issue.
149150
- A warning is displayed at the start of training if such information is included in the command line.
150151
- Also, if there is an absolute path, the path may be exposed, so it is recommended to specify a relative path or write it in the configuration file. In such cases, an INFO log is displayed.
151152
- See [#1123](https://github.com/kohya-ss/sd-scripts/pull/1123) and PR [#1240](https://github.com/kohya-ss/sd-scripts/pull/1240) for details.
@@ -223,6 +224,7 @@ See PR [#1228](https://github.com/kohya-ss/sd-scripts/pull/1228/) for details.
223224
- 依存ライブラリが更新されました。[アップグレード](./README-ja.md#アップグレード) を参照しライブラリを更新してください。
224225
- 特に `imagesize` が新しく追加されていますので、すぐにライブラリの更新ができない場合は `pip install imagesize==1.4.1` で個別にインストールしてください。
225226
- `bitsandbytes==0.43.0``prodigyopt==1.0``lion-pytorch==0.0.6` が requirements.txt に含まれるようになりました。
227+
- `bitsandbytes` が公式に Windows をサポートしたため複雑な手順が不要になりました。
226228
- また PyTorch のバージョンを 2.1.2 に更新しました。PyTorch はすぐに更新する必要はありません。更新時は、アップグレードの手順では PyTorch が更新されませんので、torch、torchvision、xformers を手動でインストールしてください。
227229
- wandb へのログ出力が有効の場合、コマンドライン全体が公開されます。そのため、コマンドラインに wandb の API キーや HuggingFace のトークンなどが含まれる場合、設定ファイル(`.toml`)への記載をお勧めします。問題提起していただいた bghira 氏に感謝します。
228230
- このような場合には学習開始時に警告が表示されます。
@@ -315,27 +317,14 @@ The LoRA supported by `train_network.py` has been named to avoid confusion. The
315317

316318
In addition to 1., LoRA for Conv2d layers with 3x3 kernel
317319

318-
LoRA-LierLa is the default LoRA type for `train_network.py` (without `conv_dim` network arg). LoRA-LierLa can be used with [our extension](https://github.com/kohya-ss/sd-webui-additional-networks) for AUTOMATIC1111's Web UI, or with the built-in LoRA feature of the Web UI.
319-
320-
To use LoRA-C3Lier with Web UI, please use our extension.
321-
322-
### LoRAの名称について
323-
324-
`train_network.py` がサポートするLoRAについて、混乱を避けるため名前を付けました。ドキュメントは更新済みです。以下は当リポジトリ内の独自の名称です。
325-
326-
1. __LoRA-LierLa__ : (LoRA for __Li__ n __e__ a __r__ __La__ yers、リエラと読みます)
327-
328-
Linear 層およびカーネルサイズ 1x1 の Conv2d 層に適用されるLoRA
329-
330-
2. __LoRA-C3Lier__ : (LoRA for __C__ olutional layers with __3__ x3 Kernel and __Li__ n __e__ a __r__ layers、セリアと読みます)
331-
332-
1.に加え、カーネルサイズ 3x3 の Conv2d 層に適用されるLoRA
333-
334-
LoRA-LierLa は[Web UI向け拡張](https://github.com/kohya-ss/sd-webui-additional-networks)、またはAUTOMATIC1111氏のWeb UIのLoRA機能で使用することができます。
320+
LoRA-LierLa is the default LoRA type for `train_network.py` (without `conv_dim` network arg).
321+
<!--
322+
LoRA-LierLa can be used with [our extension](https://github.com/kohya-ss/sd-webui-additional-networks) for AUTOMATIC1111's Web UI, or with the built-in LoRA feature of the Web UI.
335323
336-
LoRA-C3Lierを使いWeb UIで生成するには拡張を使用してください。
324+
To use LoRA-C3Lier with Web UI, please use our extension.
325+
-->
337326

338-
## Sample image generation during training
327+
### Sample image generation during training
339328
A prompt file might look like this, for example
340329

341330
```
@@ -356,26 +345,3 @@ masterpiece, best quality, 1boy, in business suit, standing at street, looking b
356345
* `--s` Specifies the number of steps in the generation.
357346

358347
The prompt weighting such as `( )` and `[ ]` are working.
359-
360-
## サンプル画像生成
361-
プロンプトファイルは例えば以下のようになります。
362-
363-
```
364-
# prompt 1
365-
masterpiece, best quality, (1girl), in white shirts, upper body, looking at viewer, simple background --n low quality, worst quality, bad anatomy,bad composition, poor, low effort --w 768 --h 768 --d 1 --l 7.5 --s 28
366-
367-
# prompt 2
368-
masterpiece, best quality, 1boy, in business suit, standing at street, looking back --n (low quality, worst quality), bad anatomy,bad composition, poor, low effort --w 576 --h 832 --d 2 --l 5.5 --s 40
369-
```
370-
371-
`#` で始まる行はコメントになります。`--n` のように「ハイフン二個+英小文字」の形でオプションを指定できます。以下が使用可能できます。
372-
373-
* `--n` Negative prompt up to the next option.
374-
* `--w` Specifies the width of the generated image.
375-
* `--h` Specifies the height of the generated image.
376-
* `--d` Specifies the seed of the generated image.
377-
* `--l` Specifies the CFG scale of the generated image.
378-
* `--s` Specifies the number of steps in the generation.
379-
380-
`( )``[ ]` などの重みづけも動作します。
381-

0 commit comments

Comments
 (0)