# ログ出力

🤗 Transformersには中央集権型のログシステムが備わっており、ライブラリの冗長性を簡単に設定できます。

現在、このライブラリのデフォルトの冗長性レベルは`WARNING`です。

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

```python
import transformers

transformers.logging.set_verbosity_info()
```

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

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

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

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

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

```python
from transformers.utils import logging

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

このロギングモジュールのすべてのメソッドは以下にドキュメント化されています。主なメソッドは、ロガーの現在の冗長度レベルを取得する [logging.get_verbosity()](/docs/transformers/v5.23.0/ja/main_classes/logging#transformers.utils.logging.get_verbosity) と、冗長度を任意のレベルに設定する [logging.set_verbosity()](/docs/transformers/v5.23.0/ja/main_classes/logging#transformers.utils.logging.set_verbosity) です。これらのレベルは、最も冗長度が低いものから最も高いものへの順に、以下の通りです（括弧内は対応する int 値）：

- `transformers.logging.CRITICAL` または `transformers.logging.FATAL`（int 値、50）：最も重大なエラーのみを報告します。
- `transformers.logging.ERROR` (int value, 40): エラーのみを報告します。
- `transformers.logging.WARNING` または `transformers.logging.WARN`（int 値、30）: エラーと警告のみを報告します。これはライブラリでデフォルトとして使用されるレベルです。
- `transformers.logging.INFO`（int 値、20）: エラー、警告、および基本的な情報を報告します。
- `transformers.logging.DEBUG`（int 値、10）：すべての情報を報告します。

デフォルトでは、モデルのダウンロード中に`tqdm`のプログレスバーが表示されます。[logging.disable_progress_bar()](/docs/transformers/v5.23.0/ja/main_classes/logging#transformers.utils.logging.disable_progress_bar)と[logging.enable_progress_bar()](/docs/transformers/v5.23.0/ja/main_classes/logging#transformers.utils.logging.enable_progress_bar)を使用して、この表示を抑制または解除できます。

## `logging` と `warnings`[[transformers.utils.logging.captureWarnings]]

Pythonには、併用されることが多い2つのログシステムがあります。上記で説明した`logging`と、警告を特定のバケットに分類できる`warnings`です。例えば、すでに非推奨とされた機能やパスには`FutureWarning`を、今後の非推奨化を示すには`DeprecationWarning`を使用します。

`transformers` ライブラリでは、両方を使用しています。`logging` の `captureWarnings` メソッドを活用・調整し、上記の冗長度設定関数によってこれらの警告メッセージを管理できるようにしています。

これはライブラリの開発者にとって何を意味するのでしょうか。以下のヒューリスティックを遵守すべきです。

- `warnings` は、`transformers` に依存するライブラリや、そのライブラリ自体の開発者にとって推奨されるべきです。
- `logging` は、日常的なプロジェクトでこのライブラリを使用するエンドユーザー向けに使用されるべきです

`captureWarnings` メソッドの詳細は、以下の参照を参照してください。

#### transformers.utils.logging.captureWarnings[[transformers.utils.logging.captureWarnings]]

```python
transformers.utils.logging.captureWarnings(capture)
```

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/utils/logging.py#L136)

ロギングライブラリから`captureWarnings`メソッドを呼び出し、`warnings`ライブラリによって発行される警告の管理を有効にします。

Read more about this method here: https://docs.python.org/3/library/logging.html#integration-with-the-warnings-module

すべての警告は、`py.warnings` ロガーを通じて記録されます。

注意: このメソッドは、このロガーにハンドラーがまだ存在しない場合にもハンドラーを追加し、そのロガーのログレベルをライブラリのルートロガーに更新します。

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

#### transformers.utils.logging.set_verbosity_error[[transformers.utils.logging.set_verbosity_error]]

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

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/utils/logging.py#L230)

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

#### transformers.utils.logging.set_verbosity_warning[[transformers.utils.logging.set_verbosity_warning]]

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

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/utils/logging.py#L220)

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

#### transformers.utils.logging.set_verbosity_info[[transformers.utils.logging.set_verbosity_info]]

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

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

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

#### transformers.utils.logging.set_verbosity_debug[[transformers.utils.logging.set_verbosity_debug]]

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

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/utils/logging.py#L225)

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

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

#### transformers.utils.logging.get_verbosity[[transformers.utils.logging.get_verbosity]]

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

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/utils/logging.py#L173)

**戻り値:** `int`

ログレベル。

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

🤗 Transformersには、次のログレベルがあります。

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

#### transformers.utils.logging.set_verbosity[[transformers.utils.logging.set_verbosity]]

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

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

**パラメータ:**

verbosity (`int`) : ログレベル。例:  - `transformers.logging.CRITICAL` または `transformers.logging.FATAL` - `transformers.logging.ERROR` - `transformers.logging.WARNING` または `transformers.logging.WARN` - `transformers.logging.INFO` - `transformers.logging.DEBUG`

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

#### transformers.utils.logging.get_logger[[transformers.utils.logging.get_logger]]

```python
transformers.utils.logging.get_logger(name: str | None = None)
```

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/utils/logging.py#L159)

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

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

#### transformers.utils.logging.enable_default_handler[[transformers.utils.logging.enable_default_handler]]

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

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/utils/logging.py#L244)

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

#### transformers.utils.logging.disable_default_handler[[transformers.utils.logging.disable_default_handler]]

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

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/utils/logging.py#L235)

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

#### transformers.utils.logging.enable_explicit_format[[transformers.utils.logging.enable_explicit_format]]

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

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/utils/logging.py#L290)

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

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

#### transformers.utils.logging.reset_format[[transformers.utils.logging.reset_format]]

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

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/utils/logging.py#L305)

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

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

#### transformers.utils.logging.enable_progress_bar[[transformers.utils.logging.enable_progress_bar]]

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

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/utils/logging.py#L410)

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

#### transformers.utils.logging.disable_progress_bar[[transformers.utils.logging.disable_progress_bar]]

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

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/utils/logging.py#L417)

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

