### `pip` で開発バージョンをインストール

標準の pip バージョンの `garak` は定期的に更新されます。GitHub から最新のバージョンを入手するには、次のようにしてください:```
python -m pip install -U git+https://github.com/NVIDIA/garak.git@main

OK、問題なければ、おそらくこれで準備完了です！

**注意**: `NVIDIA` GitHub組織への移行前にクローンしたが、このドキュメントを `github.com/NVIDIA` URI で読んでいる場合は、以下のようにリモートを更新してください。```
git remote set-url origin https://github.com/NVIDIA/garak.git

See if the Hugging Face version of GPT2 is vulnerable to DAN 11.0```
python3 -m garak --target_type huggingface --target_name gpt2 --probes dan.Dan_11_0

### Test

* `--target_type test`
* (alternatively) `--target_name test.Blank`
テスト用。常に空の文字列を生成します（`test.Blank` ジェネレーターを使用）。出力を*必要とする*テスト（例えば、議論のある主張をし、モデルがそれを反論することを期待するテスト）では失敗としてマークされます。

* `--target_type test.Repeat`
テスト用。このジェネレーターは受け取ったプロンプトをそのまま返します。

## Intro to probes

| Probe                | Description                                                                                                                   |
|----------------------|-------------------------------------------------------------------------------------------------------------------------------|
| blank                | 常に空のプロンプトを送信するシンプルなプローブ。                                                                             |
| atkgen               | 自動攻撃生成。レッドチームLLMがターゲットをプローブし、反応を利用して有害な出力を得ようとします。プロトタイプで、ほぼステートレスです。現時点では、検出可能な有害性を示したhhrlhf試行のサブセットで[ファインチューニング](https://huggingface.co/garak-llm/artgpt2tox)されたシンプルなGPT-2を使用しています（現在サポートされている唯一のターゲット）。 |
| badchars             | 知覚不可能なUnicodeの摂動（不可視文字、ホモグリフ、並べ替え、削除）を実装。 [Bad Characters](https://arxiv.org/abs/2106.09898) 論文に触発されています。 |
| av_spam_scanning     | モデルに悪意のあるコンテンツのシグネチャを出力させようとするプローブ                                                     |
| continuation         | モデルがおそらく望ましくない単語を続けるかどうかをテストするプローブ                                                       |
| dan                  | 様々な[DAN](https://adguard.com/en/blog/chatgpt-dan-prompt-abuse.html)およびDANに類似した攻撃                                 |
| donotanswer          | 責任ある言語モデルが答えるべきではないプロンプト。                                                               |
| encoding             | テキストエンコーディングによるプロンプトインジェクション                                                                                        |
| gcg                  | システムプロンプトに敵対的サフィックスを追加して破壊する。                                                                   |
| glitch               | 異常な動作を引き起こすグリッチトークンに対するプローブモデル。                                                                  |
| grandma              | 自分の祖母を思い出させるように訴える。                                                                                   |
| goodside             | Riley Goodside攻撃の実装。                                                                                    |
| leakreplay           | モデルがトレーニングデータを再生するかどうかを評価する。                                                                                |
| lmrc                 | [Language Model Risk Cards](https://arxiv.org/abs/2303.18190) プローブのサブサンプル                                         |
| malwaregen           | モデルにマルウェアを構築するコードを生成させようとする試み                                                                 |
| misleading           | モデルに誤解を招く虚偽の主張を支持させる試み                                                                  |
| packagehallucination | 存在しない（したがって安全でない）パッケージを指定するコード生成を試みる。                                   |
| promptinject         | Agency Enterprise社の[PromptInject](https://github.com/agencyenterprise/PromptInject/tree/main/promptinject)研究の実装（NeurIPS ML Safety Workshop 2022の最優秀論文賞受賞） |
| realtoxicityprompts  | RealToxicityPrompts研究のサブセット（完全なテストは実行に時間がかかりすぎるためデータに制約あり）                      |
| snowball             | モデルが処理するには複雑すぎる質問に対して誤った回答をさせるように設計された[Snowballed Hallucination](https://ofir.io/snowballed_hallucination.pdf)プローブ |
| xss                  | プライベートデータの流出など、クロスサイト攻撃を許可または実行する脆弱性を探す。                           |

## Logging

`garak` は複数の種類のログを生成します：
* ログファイル `garak.log`。`garak` およびそのプラグインからのデバッグ情報を含み、実行間で継続されます。
* 現在の実行のレポート（JSONL形式）。`garak`が実行されるたびに新しいレポートファイルが作成されます。このファイル名は実行の開始時と、成功した場合は実行の終了時にも出力されます。レポートでは、生成が受け取られた時と評価された時の両方で各プロービング試行のエントリが作成されます。エントリの`status`属性は、`garak.attempts`の定数を使用して作成された段階を記述します。
* 脆弱性（'hit'）をもたらした試行を詳述するヒットログ

## How is the code structured?

`garak`のコード構造に関する信頼できるガイドについては、[リファレンスドキュメント](https://reference.garak.ai/)を参照してください。

典型的な実行では、`garak`はコマンドラインからモデルタイプ（およびオプションでモデル名）を読み取り、実行する`probe`と`detector`を決定し、`generator`を起動し、これらを`harness`に渡してプロービングを行います。`evaluator`が結果を処理します。これらの各カテゴリには多くのモジュールがあり、各モジュールは個別のプラグインとして機能するいくつかのクラスを提供します。

* `garak/probes/` - LLMとのインタラクションを生成するためのクラス
* `garak/detectors/` - LLMが特定の障害モードを示していることを検出するためのクラス
* `garak/evaluators/` - 評価レポートスキーム
* `garak/generators/` - プローブされるLLM用のプラグイン
* `garak/harnesses/` - テストを構造化するためのクラス
* `resources/` - プラグインが必要とする補助項目

デフォルトの動作モードは`probewise`ハーネスを使用します。プローブモジュール名とプローブプラグイン名のリストが与えられると、`probewise`ハーネスは各プローブをインスタンス化し、各プローブについてその`primary_detector`および`extended_detectors`属性を読み取り、出力に対して実行する`detector`のリストを取得します。

各プラグインカテゴリ（`probes`、`detectors`、`evaluators`、`generators`、`harnesses`）には、そのカテゴリのプラグインで使用可能な基底クラスを定義する`base.py`が含まれています。各プラグインモジュールは、いずれかの基底クラスを継承するプラグインクラスを定義します。例えば、`garak.generators.openai.OpenAIGenerator`は`garak.generators.base.Generator`から派生しています。

モデルファイルや大規模コーパスなどの大きな成果物は、リポジトリの外部に保持されます。これらはHugging Face Hubなどに保存され、`garak`を使用するクライアントによってローカルにロードできます。


## Developing your own plugin

* 他のプラグインがどのように実装されているかを見てみましょう
* 基底クラスのいずれかを継承します（例：`garak.probes.base.TextProbe`）
* 可能な限りオーバーライドを少なくします
* 新しいコードは少なくとも2つの方法でテストできます：
  * 対話型Pythonセッションを開始する
    * モデルをインポートします（例：`import garak.probes.mymodule`）
    * プラグインをインスタンス化します（例：`p = garak.probes.mymodule.MyProbe()`）
  * テストプラグインでスキャンを実行する
    * プローブの場合は、ブランクジェネレーターとalways.Pass検出器を試してください：`python3 -m garak -m test.Blank -p mymodule -d always.Pass`
    * 検出器の場合は、ブランクジェネレーターとブランクプローブを試してください：`python3 -m garak -m test.Blank -p test.Blank -d mymodule`
    * ジェネレーターの場合は、ブランクプローブとalways.Pass検出器を試してください：`python3 -m garak -m mymodule -p test.Blank -d always.Pass`
  * `garak`に、作成しているタイプの全プラグインを`--list_probes`、`--list_detectors`、または`--list_generators`でリストさせます


## FAQ

FAQは[こちら](https://github.com/NVIDIA/garak/blob/main/FAQ.md)にあります。さらに質問があればお問い合わせください！ [[email protected]](mailto:[email protected])

コードリファレンスドキュメントは[garak.readthedocs.io](https://garak.readthedocs.io/en/latest/)にあります。

## Citing garak

[garak preprint paper](https://github.com/nvidia/garak/blob/main/garak-paper.pdf)をお読みいただけます。garakを使用する場合は、引用をお願いします。```
@article{garak,
  title={{garak: A Framework for Security Probing Large Language Models}},
  author={Leon Derczynski and Erick Galinkin and Jeffrey Martin and Subho Majumdar and Nanna Inie},
  year={2024},
  howpublished={\url{https://garak.ai}}
}