> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-sdk-testing-latest.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Image

export const GitHubLink = ({url}) => <a href={url} target="_blank" rel="noopener noreferrer" className="github-source-link">
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" />
    </svg>
    GitHub のソース
  </a>;

<GitHubLink url="https://github.com/wandb/wandb/blob/main/wandb/sdk/data_types/image.py" />

## <kbd>class</kbd> `Image`

画像をW\&Bにログするためのクラスです。

### <kbd>method</kbd> `Image.__init__`

```python theme={null}
__init__(
    data_or_path: 'ImageDataOrPathType',
    mode: 'str | None' = None,
    caption: 'str | None' = None,
    grouping: 'int | None' = None,
    classes: 'Classes | Sequence[dict] | None' = None,
    boxes: 'dict[str, BoundingBoxes2D] | dict[str, dict] | None' = None,
    masks: 'dict[str, ImageMask] | dict[str, dict] | None' = None,
    file_type: 'str | None' = None,
    normalize: 'bool' = True
) → None
```

`wandb.Image` オブジェクトを初期化します。

このクラスはさまざまな画像データ形式を処理し、必要に応じてピクセル値を自動的に \[0, 255] の範囲に正規化して、W\&B バックエンドとの互換性を確保します。

* \[0, 1] の範囲のデータは 255 倍され、uint8 に変換されます \_ \[-1, 1] の範囲のデータは、-1 を 0、1 を 255 に対応付けて \[-1, 1] から \[0, 255] に再スケーリングした後、uint8 に変換されます
  -1 を 0、1 を 255 に対応付けた後、uint8 に変換されます \_ \[-1, 1] の範囲外で \[0, 255] に含まれないデータは \[0, 255] にクリップされ、uint8 に変換されます (値が \[0, 255] の範囲外にある場合は警告が表示されます) \* すでに \[0, 255] の範囲にあるデータは、変更せずに uint8 に変換されます

**引数:**

* `data_or_path`:  画像データの NumPy array / pytorch tensor、PIL image object、または画像ファイルへのパスを受け付けます。NumPy array または pytorch tensor を指定した場合、画像データは指定したファイルタイプで保存されます。値が \[0, 255] の範囲外である場合、またはすべての値が \[0, 1] の範囲内である場合は、`normalize` が `False` に設定されていない限り、画像のピクセル値は \[0, 255] の範囲に正規化されます。
  * pytorch tensor は (channel, height, width) 形式である必要があります
  * NumPy array は (height, width, channel) 形式である必要があります
* `mode`:  画像の PIL mode です。一般的なものは "L"、"RGB"、"RGBA" です。
* `Full Pillow docs for more information https`: //pillow\.readthedocs.io/en/stable/handbook/concepts.html#modes
* `caption`:  画像の表示ラベルです。
* `grouping`:  画像のグループ化番号です。
* `classes`:  画像のクラス情報の list で、バウンディングボックスや画像マスクのラベル付けに使用されます。
* `boxes`:  画像のバウンディングボックス情報を含む辞書です。
* `see https`: //docs.wandb.ai/models/ref/python/data-types/boundingboxes2d
* `masks`:  画像のマスク情報を含む辞書です。
* `see https`: //docs.wandb.ai/models/ref/python/data-types/imagemask
* `file_type`:  画像の保存ファイルタイプです。`data_or_path` が画像ファイルへのパスである場合、このパラメーターは効果を持ちません。
* `normalize`:  `True` の場合、画像のピクセル値が \[0, 255] の範囲内に収まるよう正規化します。正規化は、`data_or_path` が numpy array または pytorch tensor の場合にのみ適用されます。

**例:**
numpy array から wandb.Image を作成します

```python theme={null}
import numpy as np
import wandb

with wandb.init() as run:
    examples = []
    for i in range(3):
         pixels = np.random.randint(low=0, high=256, size=(100, 100, 3))
         image = wandb.Image(pixels, caption=f"random field {i}")
         examples.append(image)
    run.log({"examples": examples})
```

PILImage から wandb.Image を作成する

```python theme={null}
import numpy as np
from PIL import Image as PILImage
import wandb

with wandb.init() as run:
    examples = []
    for i in range(3):
         pixels = np.random.randint(
             low=0, high=256, size=(100, 100, 3), dtype=np.uint8
         )
         pil_image = PILImage.fromarray(pixels, mode="RGB")
         image = wandb.Image(pil_image, caption=f"random field {i}")
         examples.append(image)
    run.log({"examples": examples})
```

.png (デフォルト) ではなく .jpg でログする

```python theme={null}
import numpy as np
import wandb

with wandb.init() as run:
    examples = []
    for i in range(3):
         pixels = np.random.randint(low=0, high=256, size=(100, 100, 3))
         image = wandb.Image(
             pixels, caption=f"random field {i}", file_type="jpg"
         )
         examples.append(image)
    run.log({"examples": examples})
```

***

### <kbd>プロパティ</kbd> Image.image

***
