# パイプライン用のユーティリティ

このページでは、パイプライン用にライブラリが提供するすべてのユーティリティ関数を一覧で示しています。

これらの多くは、ライブラリ内のモデルのコードを研究する場合にのみ有用です。

## 引数の処理[[transformers.pipelines.ArgumentHandler]]

#### transformers.pipelines.ArgumentHandler[[transformers.pipelines.ArgumentHandler]]

```python
transformers.pipelines.ArgumentHandler()
```

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/pipelines/base.py#L388)

[Pipeline](/docs/transformers/v5.23.0/ja/main_classes/pipelines#transformers.Pipeline)ごとの引数処理を行うためのベースインターフェースです。

#### transformers.pipelines.ZeroShotClassificationArgumentHandler[[transformers.pipelines.ZeroShotClassificationArgumentHandler]]

```python
transformers.pipelines.ZeroShotClassificationArgumentHandler()
```

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/pipelines/zero_shot_classification.py#L13)

テキスト分類のゼロショット処理において、各候補ラベルをNLIの前提文/仮説文ペアに変換することで、引数を処理します。

## データ形式[[transformers.PipelineDataFormat]]

#### transformers.PipelineDataFormat[[transformers.PipelineDataFormat]]

```python
transformers.PipelineDataFormat(output_path: str | None, input_path: str | None, column: str | None, overwrite: bool = False)
```

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/pipelines/base.py#L398)

**パラメータ:**

output_path (`str`) : 送信データを保存する場所。

input_path (`str`) : 入力データを参照する場所。

column (`str`) : 読み取る対象の列。

overwrite (`bool`、*任意*、デフォルトは`False`) : `output_path`を上書きするかどうか。

読み取りと書き出しの両方で、すべてのパイプラインがサポートするデータ形式の基底クラスです。現在サポートされているデータ形式には、以下が含まれます:

- JSON
- CSV
- stdin/stdout（パイプ）

`PipelineDataFormat` には、`dataset_kwarg_1=dataset_column_1` という形式で、datasets のカラムから pipelines のキーワード引数へのマッピングなど、複数カラムを扱うためのユーティリティも含まれています。

#### from_str[[transformers.PipelineDataFormat.from_str]]

```python
from_str(format: str, output_path: str | None, input_path: str | None, column: str | None, overwrite = False)
```

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/pipelines/base.py#L475)

**パラメータ:**

format (`str`) : 望むパイプラインの形式。受け入れられる値は `"json"`、`"csv"`、または `"pipe"` です。

output_path (`str`、*任意*) : 送信データを保存する場所。

input_path (`str`、*任意*) : 入力データを探す場所。

column (`str`, *任意*) : 読み取る対象の列。

overwrite (`bool`、*任意*、デフォルトは`False`) : `output_path`を上書きするかどうか。

**戻り値:** [PipelineDataFormat](/docs/transformers/v5.23.0/ja/internal/pipelines_utils#transformers.PipelineDataFormat)

適切なデータ形式。

`format` に応じて、[PipelineDataFormat](/docs/transformers/v5.23.0/ja/internal/pipelines_utils#transformers.PipelineDataFormat) の適切なサブクラスのインスタンスを作成します。

#### 保存[[transformers.PipelineDataFormat.save]]

```python
save(data: dict | list[dict])
```

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/pipelines/base.py#L447)

**パラメータ:**

data (`dict` または `dict` のリスト) : 保存するデータ。

現在の[PipelineDataFormat](/docs/transformers/v5.23.0/ja/internal/pipelines_utils#transformers.PipelineDataFormat)の表現を持つ、提供されたデータオブジェクトを保存します。

#### save_binary[[transformers.PipelineDataFormat.save_binary]]

```python
save_binary(data: dict | list[dict])
```

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/pipelines/base.py#L457)

**パラメータ:**

data (`dict` または `dict` のリスト) : 保存するデータ。

**戻り値:** `str`

データが保存されたパス。

提供されたデータオブジェクトを、pickle形式のバイナリデータとしてディスクに保存します。

#### transformers.CsvPipelineDataFormat[[transformers.CsvPipelineDataFormat]]

```python
transformers.CsvPipelineDataFormat(output_path: str | None, input_path: str | None, column: str | None, overwrite = False)
```

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/pipelines/base.py#L511)

**パラメータ:**

output_path (`str`) : 送信データを保存する場所。

input_path (`str`) : 入力データを参照する場所。

column (`str`) : 読み取る対象の列。

overwrite (`bool`、*任意*、デフォルトは`False`) : `output_path`を上書きするかどうか。

CSVデータ形式を使用したパイプラインのサポート。

#### 保存[[transformers.CsvPipelineDataFormat.save]]

```python
save(data: list[dict])
```

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/pipelines/base.py#L541)

**パラメータ:**

data (`list[dict]`) : 保存するデータ。

現在の[PipelineDataFormat](/docs/transformers/v5.23.0/ja/internal/pipelines_utils#transformers.PipelineDataFormat)の表現を持つ、提供されたデータオブジェクトを保存します。

#### transformers.JsonPipelineDataFormat[[transformers.JsonPipelineDataFormat]]

```python
transformers.JsonPipelineDataFormat(output_path: str | None, input_path: str | None, column: str | None, overwrite = False)
```

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/pipelines/base.py#L555)

**パラメータ:**

output_path (`str`) : 送信データを保存する場所。

input_path (`str`) : 入力データを参照する場所。

column (`str`) : 読み取る対象の列。

overwrite (`bool`、*任意*、デフォルトは`False`) : `output_path`を上書きするかどうか。

JSONファイル形式を使用したパイプラインのサポート。

#### 保存[[transformers.JsonPipelineDataFormat.save]]

```python
save(data: dict)
```

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/pipelines/base.py#L586)

**パラメータ:**

data (`dict`) : 保存するデータ。

提供されたデータオブジェクトをjsonファイルに保存します。

#### transformers.PipedPipelineDataFormat[[transformers.PipedPipelineDataFormat]]

```python
transformers.PipedPipelineDataFormat(output_path: str | None, input_path: str | None, column: str | None, overwrite: bool = False)
```

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/pipelines/base.py#L597)

**パラメータ:**

output_path (`str`) : 送信データを保存する場所。

input_path (`str`) : 入力データを参照する場所。

column (`str`) : 読み取る対象の列。

overwrite (`bool`、*任意*、デフォルトは`False`) : `output_path`を上書きするかどうか。

Python プロセスのパイプ入力からデータを読み取ります。複数カラムのデータの場合、カラムはで区切ってください。

カラムが指定されている場合、出力は{column_x: value_x}形式の辞書になります。

#### 保存[[transformers.PipedPipelineDataFormat.save]]

```python
save(data: dict)
```

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/pipelines/base.py#L626)

**パラメータ:**

data (`dict`) : 保存するデータ。

データを出力します。

## ユーティリティ[[transformers.pipelines.PipelineException]]

#### transformers.pipelines.PipelineException[[transformers.pipelines.PipelineException]]

```python
transformers.pipelines.PipelineException(task: str, model: str, reason: str)
```

[ソース](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/pipelines/base.py#L371)

**パラメータ:**

task (`str`) : パイプラインのタスク。

model (`str`) : パイプラインで使用されるモデル。

reason (`str`) : 表示するエラーメッセージ。

__call__ を処理する際に、[Pipeline](/docs/transformers/v5.23.0/ja/main_classes/pipelines#transformers.Pipeline) によって発生します。

