# 哲学

Transformers は PyTorch 優先のライブラリです。論文に忠実で、使いやすく、ハッキングしやすいモデルを提供しています。

例やビジュアライゼーション、タイムラインを伴う、より詳細な記事は、正規の参照資料として[こちら](https://huggingface.co/spaces/transformers-community/Transformers-tenets)でご利用いただけます。

> [!NOTE]
> 私たちの哲学は実践を通じて進化します。以下に、現在の安定した原則を記載します。

## このライブラリが対象とする方

- モデルアーキテクチャの探索や拡張に取り組む研究者や教育者。
- モデルのファインチューニング、評価、サービングを行う実務者。
- 予測可能なAPIで「すぐ使える」事前学習済みモデルを求めているエンジニア。

## 期待できること

- 各モデルには3つのコアクラスが必要です: [configuration](./main_classes/configuration)、[models](./main_classes/model)、および前処理クラスです。[Tokenizers](./main_classes/tokenizer)はNLPを、[image processors](./main_classes/image_processor)は画像を、[video processors](./main_classes/video_processor)は動画を、[feature extractors](./main_classes/feature_extractor)はオーディオを、[processors](./main_classes/processors)はマルチモーダル入力を処理します。

- これらのクラスはすべて、[Hugging Face Hub](https://huggingface.co/models)または自分で保存したチェックポイントから提供される事前学習済みチェックポイントから、関連するクラスインスタンスおよび関連データ（設定のハイパーパラメータ、トークナイザの語彙、プロセッサのパラメータ、モデルの重み）をダウンロード（必要に応じて）、キャッシュし、読み込む共通の`from_pretrained()`メソッドを使用することで、シンプルかつ統一された方法で事前学習済みインスタンスから初期化できます。
- これら3つのベースクラスの上に、ライブラリは2つのAPIを提供しています。与えられたタスクに対してモデルを素早く推論に使用するための[pipeline()](/docs/transformers/v5.23.0/ja/main_classes/pipelines#transformers.pipeline)と、PyTorchモデルを素早く学習またはファインチューニングするための[Trainer](/docs/transformers/v5.23.0/ja/main_classes/trainer#transformers.Trainer)です。

## 基本理念

以下の原則は時間の経過とともに確立され、新しい哲学に関する[ブログ記事](https://huggingface.co/spaces/transformers-community/Transformers-tenets)で詳細が説明されています。これらは、PRやコントリビューションのレビュー時にメンテナーの判断を導くものです。

> - **唯一の正解。** 実装は、公式の結果や意図された動作に忠実でなければなりません。 - **1つのモデル、1つのファイル。** コアとなる推論/学習ロジックは、ユーザーが読むモデルファイル内で上から下まで一貫して確認できる必要があります。 - **コードがプロダクトである。** 読みやすさと差分確認のしやすさを最優先します。巧妙な間接参照よりも、明示的な名前を優先します。 - **標準化し、抽象化しない。** モデル固有の動作はモデル内に保持します。共有インターフェースは汎用的なインフラストラクチャにのみ使用します。 - **DRY\*** (ユーザーに役立つ場合は繰り返す)。エンドユーザー向けのモデリングファイルは自己完結型を維持します。インフラストラクチャは分離します。 - **最小限のユーザーAPI。** コードパスを少なくし、予測可能なkwargsと安定したメソッドを提供します。 - **後方互換性。** 公開インターフェースは壊れてはなりません。古いHubの成果物も引き続き動作する必要があります。 - **一貫した公開インターフェース。** 命名規則、出力、および任意の診断情報は整合性を保ち、テストされています。

## 主要クラス

- [**設定クラス**](./main_classes/configuration)は、モデルを構築するために必要なハイパーパラメータを保存します。これには、レイヤー数や隠れ層サイズなどが含まれます。必ずしも自分でインスタンス化する必要はありません。変更なしで事前学習済みモデルを使用する場合、モデルの作成時に設定が自動的にインスタンス化されます。
- **モデルクラス**は、少なくとも [PreTrainedModel](/docs/transformers/v5.23.0/ja/main_classes/model#transformers.PreTrainedModel) によってラップされた PyTorch モデル（[torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module)）です。

- **モジュラーな Transformers。**コントリビューターは、既存のコンポーネントからの再利用を宣言する小さな`modular_*.py`シャードを作成します。ライブラリはこれを自動的に展開し、ユーザーが読み取り・デバッグする`modeling_*.py`ファイルが生成されます。メンテナーはシャードをレビューし、ユーザーは展開されたファイルを修正します。これにより、ボイラープレートコードの乖離を避けながら「1つのモデル、1つのファイル」の原則を維持できます。詳細は[コントリビューションのドキュメント](./modular_transformers)を参照してください。

- **前処理クラス**は、生データをモデルが受け入れる形式に変換します。[トークナイザー](./main_classes/tokenizer)は各モデルの語彙を保持し、文字列をトークン埋め込みインデックスのリストとしてエンコードおよびデコードするためのメソッドを提供します。[画像プロセッサー](./main_classes/image_processor)は視覚入力の前処理を行い、[動画プロセッサー](./main_classes/video_processor)は動画入力の前処理を行い、[特徴抽出器](./main_classes/feature_extractor)は音声入力の前処理を行い、[プロセッサー](./main_classes/processors)はマルチモーダル入力の前処理を行います。

これらのクラスはすべて、事前学習済みインスタンスからインスタンス化でき、ローカルに保存し、Hubで共有できます。以下の3つのメソッドを使用します。

- `from_pretrained()` は、ライブラリ自体が提供する事前学習済みバージョン（サポートされているモデルは[Model Hub](https://huggingface.co/models)で確認できます）または、ユーザーがローカル（またはサーバー）に保存した事前学習済みバージョンから、モデル、設定、前処理クラスをインスタンス化できます。
- `save_pretrained()` を使用すると、モデル、設定、前処理クラスをローカルに保存でき、`from_pretrained()` を使って読み戻すことができます。
- `push_to_hub()` を使用すると、モデル、設定、前処理クラスを Hub に共有でき、誰でも簡単にアクセスできるようになります。

