Buckets:

hf-doc-build
/

doc

Files

xet

hf-doc-build/doc / diffusers /main /ja /api /logging.md

mishig

8 days ago

preview code

download

raw

8.45 kB

# ログ出力

🤗 Diffusersには、ライブラリの冗長さを簡単に管理するための集中型ログシステムがあります。デフォルトの冗長度は`WARNING`に設定されています。

冗長レベルを変更するには、直接セッターのいずれかを使用します。例えば、冗長レベルを`INFO`レベルに変更するには。

```python
import diffusers
diffusers.logging.set_verbosity_info()
```

環境変数`DIFFUSERS_VERBOSITY`を使用して、デフォルトの冗長性を上書きすることもできます。以下のいずれかに設定できます:`debug`、`info`、`warning`、`error`、`critical`。例:

```bash
DIFFUSERS_VERBOSITY=error ./myprogram.py
```

また、環境変数`DIFFUSERS_NO_ADVISORY_WARNINGS`を`1`などの真の値に設定することで、一部の`warnings`を無効にできます。これにより、`logger.warning_advice`によって記録されるすべての警告が無効になります。例:

```bash
DIFFUSERS_NO_ADVISORY_WARNINGS=1 ./myprogram.py
```

ライブラリと同じロガーを、ご自身のモジュールやスクリプトで使用する例を以下に示します。

```python
from diffusers.utils import logging
logging.set_verbosity_info()
logger = logging.get_logger("diffusers")
logger.info("INFO")
logger.warning("WARN")
```

loggingモジュールのすべてのメソッドは以下にドキュメント化されています。主なメソッドは、ロガーの現在の冗長性レベルを取得する`logging.get_verbosity`と、冗長性を希望するレベルに設定する`logging.set_verbosity`です。

冗長さが少ない順から多い順に:

|                                                    メソッド | 整数値 |                                         説明 |
|----------------------------------------------------------:|--------------:|----------------------------------------------------:|
| `diffusers.logging.CRITICAL` または `diffusers.logging.FATAL` |            50 |                最も重大なエラーのみを報告します |
|                                 `diffusers.logging.ERROR` |            40 |                                  エラーのみ報告 |
|   `diffusers.logging.WARNING` または `diffusers.logging.WARN` |            30 |           エラーと警告のみを報告します（デフォルト） |
|                                  `diffusers.logging.INFO` |            20 | エラー、警告、および基本的な情報のみを報告します |
|                                 `diffusers.logging.DEBUG` |            10 |                              すべての情報を報告します |

デフォルトでは、モデルのダウンロード中に`tqdm`のプログレスバーが表示されます。`logging.disable_progress_bar`と`logging.enable_progress_bar`を使用して、この動作を有効化または無効化できます。

## ベースセッター[[diffusers.utils.logging.set_verbosity_error]]

#### diffusers.utils.logging.set_verbosity_error[[diffusers.utils.logging.set_verbosity_error]]

```python
diffusers.utils.logging.set_verbosity_error()
```

[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L201)

冗長レベルを`ERROR`に設定します。

#### diffusers.utils.logging.set_verbosity_warning[[diffusers.utils.logging.set_verbosity_warning]]

```python
diffusers.utils.logging.set_verbosity_warning()
```

[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L191)

冗長レベルを`WARNING`に設定します。

#### diffusers.utils.logging.set_verbosity_info[[diffusers.utils.logging.set_verbosity_info]]

```python
diffusers.utils.logging.set_verbosity_info()
```

[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L186)

冗長レベルを`INFO`に設定します。

#### diffusers.utils.logging.set_verbosity_debug[[diffusers.utils.logging.set_verbosity_debug]]

```python
diffusers.utils.logging.set_verbosity_debug()
```

[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L196)

冗長レベルを`DEBUG`に設定します。

## その他の関数[[diffusers.utils.logging.get_verbosity]]
#### diffusers.utils.logging.get_verbosity[[diffusers.utils.logging.get_verbosity]]
```python
diffusers.utils.logging.get_verbosity()
```
[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L147)
**戻り値:** `int`
…
- `50`: `diffusers.logging.CRITICAL` または `diffusers.logging.FATAL`
- `40`: `diffusers.logging.ERROR`
- `30`: `diffusers.logging.WARNING` または `diffusers.logging.WARN`
- `20`: `diffusers.logging.INFO`
- `10`: `diffusers.logging.DEBUG`
🤗 Diffusers のルートロガーの現在のレベルを`int`として返します。
#### diffusers.utils.logging.set_verbosity[[diffusers.utils.logging.set_verbosity]]
```python
diffusers.utils.logging.set_verbosity(verbosity: int)
```
[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L167)
**パラメータ:**
verbosity (`int`) : ログレベル。以下のいずれかの値を指定できます: - `diffusers.logging.CRITICAL` または `diffusers.logging.FATAL` - `diffusers.logging.ERROR` - `diffusers.logging.WARNING` または `diffusers.logging.WARN` - `diffusers.logging.INFO` - `diffusers.logging.DEBUG`
🤗 Diffusers のルートロガーの冗長レベルを設定します。
#### diffusers.utils.get_logger[[diffusers.utils.get_logger]]
```python
diffusers.utils.get_logger(name: str | None = None)
```
[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L131)
指定された名前のロガーを返します。
この関数は、カスタムのdiffusersモジュールを作成している場合を除き、直接アクセスするようには設計されていません。
#### diffusers.utils.logging.enable_default_handler[[diffusers.utils.logging.enable_default_handler]]
```python
diffusers.utils.logging.enable_default_handler()
```
[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L215)
🤗 Diffusers のルートロガーのデフォルトハンドラーを有効にします。
#### diffusers.utils.logging.disable_default_handler[[diffusers.utils.logging.disable_default_handler]]
```python
diffusers.utils.logging.disable_default_handler()
```
[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L206)
🤗 Diffusersのルートロガーのデフォルトハンドラーを無効にします。
#### diffusers.utils.logging.enable_explicit_format[[diffusers.utils.logging.enable_explicit_format]]
```python
diffusers.utils.logging.enable_explicit_format()
```
[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L261)
🤗 Diffusers のすべてのロガーに対して明示的なフォーマットを有効にします。明示的なフォーマッタは以下の通りです。
```
[LEVELNAME|FILENAME|LINE NUMBER] TIME >> MESSAGE
```
このメソッドは、ルートロガーに現在バインドされているすべてのハンドラーに影響します。
#### diffusers.utils.logging.reset_format[[diffusers.utils.logging.reset_format]]
```python
diffusers.utils.logging.reset_format()
```
[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L276)
🤗 Diffusers のロガーのフォーマットをリセットします。
このメソッドは、ルートロガーに現在バインドされているすべてのハンドラーに影響します。
#### diffusers.utils.logging.enable_progress_bar[[diffusers.utils.logging.enable_progress_bar]]
```python
diffusers.utils.logging.enable_progress_bar()
```
[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L352)
tqdmのプログレスバーを有効にします。
#### diffusers.utils.logging.disable_progress_bar[[diffusers.utils.logging.disable_progress_bar]]
```python
diffusers.utils.logging.disable_progress_bar()
```
[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L358)
tqdmのプログレスバーを無効にします。

Xet Storage Details

Size:: 8.45 kB
Xet hash:: 7c3049749d3e393c9fd3f8bda654cc5b538bb1ad2a4cde6dc54837bb259bdb3c

Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.

	# ログ出力

	🤗 Diffusersには、ライブラリの冗長さを簡単に管理するための集中型ログシステムがあります。デフォルトの冗長度は`WARNING`に設定されています。

	冗長レベルを変更するには、直接セッターのいずれかを使用します。例えば、冗長レベルを`INFO`レベルに変更するには。

	```python
	import diffusers

	diffusers.logging.set_verbosity_info()
	```

	環境変数`DIFFUSERS_VERBOSITY`を使用して、デフォルトの冗長性を上書きすることもできます。以下のいずれかに設定できます:`debug`、`info`、`warning`、`error`、`critical`。例:

	```bash
	DIFFUSERS_VERBOSITY=error ./myprogram.py
	```

	また、環境変数`DIFFUSERS_NO_ADVISORY_WARNINGS`を`1`などの真の値に設定することで、一部の`warnings`を無効にできます。これにより、`logger.warning_advice`によって記録されるすべての警告が無効になります。例:

	```bash
	DIFFUSERS_NO_ADVISORY_WARNINGS=1 ./myprogram.py
	```

	ライブラリと同じロガーを、ご自身のモジュールやスクリプトで使用する例を以下に示します。

	```python
	from diffusers.utils import logging

	logging.set_verbosity_info()
	logger = logging.get_logger("diffusers")
	logger.info("INFO")
	logger.warning("WARN")
	```

	loggingモジュールのすべてのメソッドは以下にドキュメント化されています。主なメソッドは、ロガーの現在の冗長性レベルを取得する`logging.get_verbosity`と、冗長性を希望するレベルに設定する`logging.set_verbosity`です。

	冗長さが少ない順から多い順に:

	\| メソッド \| 整数値 \| 説明 \|
	\|----------------------------------------------------------:\|--------------:\|----------------------------------------------------:\|
	\| `diffusers.logging.CRITICAL` または `diffusers.logging.FATAL` \| 50 \| 最も重大なエラーのみを報告します \|
	\| `diffusers.logging.ERROR` \| 40 \| エラーのみ報告 \|
	\| `diffusers.logging.WARNING` または `diffusers.logging.WARN` \| 30 \| エラーと警告のみを報告します（デフォルト） \|
	\| `diffusers.logging.INFO` \| 20 \| エラー、警告、および基本的な情報のみを報告します \|
	\| `diffusers.logging.DEBUG` \| 10 \| すべての情報を報告します \|

	デフォルトでは、モデルのダウンロード中に`tqdm`のプログレスバーが表示されます。`logging.disable_progress_bar`と`logging.enable_progress_bar`を使用して、この動作を有効化または無効化できます。

	## ベースセッター[[diffusers.utils.logging.set_verbosity_error]]

	#### diffusers.utils.logging.set_verbosity_error[[diffusers.utils.logging.set_verbosity_error]]

	```python
	diffusers.utils.logging.set_verbosity_error()
	```

	[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L201)

	冗長レベルを`ERROR`に設定します。

	#### diffusers.utils.logging.set_verbosity_warning[[diffusers.utils.logging.set_verbosity_warning]]

	```python
	diffusers.utils.logging.set_verbosity_warning()
	```

	[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L191)

	冗長レベルを`WARNING`に設定します。

	#### diffusers.utils.logging.set_verbosity_info[[diffusers.utils.logging.set_verbosity_info]]

	```python
	diffusers.utils.logging.set_verbosity_info()
	```

	[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L186)

	冗長レベルを`INFO`に設定します。

	#### diffusers.utils.logging.set_verbosity_debug[[diffusers.utils.logging.set_verbosity_debug]]

	```python
	diffusers.utils.logging.set_verbosity_debug()
	```

	[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L196)

	冗長レベルを`DEBUG`に設定します。

	## その他の関数[[diffusers.utils.logging.get_verbosity]]

	#### diffusers.utils.logging.get_verbosity[[diffusers.utils.logging.get_verbosity]]

	```python
	diffusers.utils.logging.get_verbosity()
	```

	[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L147)

	戻り値: `int`

	…

	- `50`: `diffusers.logging.CRITICAL` または `diffusers.logging.FATAL`
	- `40`: `diffusers.logging.ERROR`
	- `30`: `diffusers.logging.WARNING` または `diffusers.logging.WARN`
	- `20`: `diffusers.logging.INFO`
	- `10`: `diffusers.logging.DEBUG`

	🤗 Diffusers のルートロガーの現在のレベルを`int`として返します。

	#### diffusers.utils.logging.set_verbosity[[diffusers.utils.logging.set_verbosity]]

	```python
	diffusers.utils.logging.set_verbosity(verbosity: int)
	```

	[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L167)

	パラメータ:

	verbosity (`int`) : ログレベル。以下のいずれかの値を指定できます: - `diffusers.logging.CRITICAL` または `diffusers.logging.FATAL` - `diffusers.logging.ERROR` - `diffusers.logging.WARNING` または `diffusers.logging.WARN` - `diffusers.logging.INFO` - `diffusers.logging.DEBUG`

	🤗 Diffusers のルートロガーの冗長レベルを設定します。

	#### diffusers.utils.get_logger[[diffusers.utils.get_logger]]

	```python
	diffusers.utils.get_logger(name: str \| None = None)
	```

	[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L131)

	指定された名前のロガーを返します。

	この関数は、カスタムのdiffusersモジュールを作成している場合を除き、直接アクセスするようには設計されていません。

	#### diffusers.utils.logging.enable_default_handler[[diffusers.utils.logging.enable_default_handler]]

	```python
	diffusers.utils.logging.enable_default_handler()
	```

	[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L215)

	🤗 Diffusers のルートロガーのデフォルトハンドラーを有効にします。

	#### diffusers.utils.logging.disable_default_handler[[diffusers.utils.logging.disable_default_handler]]

	```python
	diffusers.utils.logging.disable_default_handler()
	```

	[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L206)

	🤗 Diffusersのルートロガーのデフォルトハンドラーを無効にします。

	#### diffusers.utils.logging.enable_explicit_format[[diffusers.utils.logging.enable_explicit_format]]

	```python
	diffusers.utils.logging.enable_explicit_format()
	```

	[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L261)

	🤗 Diffusers のすべてのロガーに対して明示的なフォーマットを有効にします。明示的なフォーマッタは以下の通りです。
	```
	[LEVELNAME\|FILENAME\|LINE NUMBER] TIME >> MESSAGE
	```

	このメソッドは、ルートロガーに現在バインドされているすべてのハンドラーに影響します。

	#### diffusers.utils.logging.reset_format[[diffusers.utils.logging.reset_format]]

	```python
	diffusers.utils.logging.reset_format()
	```

	[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L276)

	🤗 Diffusers のロガーのフォーマットをリセットします。

	このメソッドは、ルートロガーに現在バインドされているすべてのハンドラーに影響します。

	#### diffusers.utils.logging.enable_progress_bar[[diffusers.utils.logging.enable_progress_bar]]

	```python
	diffusers.utils.logging.enable_progress_bar()
	```

	[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L352)

	tqdmのプログレスバーを有効にします。

	#### diffusers.utils.logging.disable_progress_bar[[diffusers.utils.logging.disable_progress_bar]]

	```python
	diffusers.utils.logging.disable_progress_bar()
	```

	[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/utils/logging.py#L358)

	tqdmのプログレスバーを無効にします。