Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ For example, you can edit the default Ollama Connector configuration file `AVISE
}
```

### Configuring Security Evaluation Tests (SETs)

Similarly, you can customize the configurations for SETs as well. For example, by editing the Red Queen SET configuration file `AVISE/avise/configs/SET/languagemodel/multi_turn/red_queen.json`,
you can define if the SET is executed incrementally *(the target model will generate a response after each subsequential prompt)*, or as a template *(only works for target systems that accept a conversation as an input)* and if the SET uses and Adversarial Language Model (ALM).
Additionally, you can define the exact template attack prompts that the SET uses:
Expand Down Expand Up @@ -131,6 +133,8 @@ Additionally, you can define the exact template attack prompts that the SET uses
]
```

### Using custom configuration files


If you want to use custom configuration files for SETs and/or Connectors, you can do so by giving the paths to the configuration files with `--SETconf` and `--connectorconf` arguments:

Expand Down
7 changes: 7 additions & 0 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,10 @@ For example, you can edit the default Ollama Connector configuration file ``AVIS
}
}


Configuring Security Evaluation Tests (SETs)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Similarly, you can customize the configurations for SETs as well. For example, by editing the Red Queen SET configuration file ``AVISE/avise/configs/SET/languagemodel/multi_turn/red_queen.json``,
you can define if the SET is executed incrementally *(the target model will generate a response after each subsequential prompt)*, or as a template *(only works for target systems that accept a conversation as an input)* and if the SET uses an Adversarial Language Model (ALM).
Additionally, you can define the exact template attack prompts that the SET uses:
Expand All @@ -140,6 +144,9 @@ Additionally, you can define the exact template attack prompts that the SET uses
]
}

Using custom configuration files
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you want to use custom configuration files for SETs and/or Connectors, you can do so by giving the paths to the configuration files with ``--SETconf`` and ``--connectorconf`` arguments:

.. code-block:: bash
Expand Down
8 changes: 8 additions & 0 deletions docs/source/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,10 @@ For example, you can edit the default Ollama Connector configuration file ``AVIS
}
}


Configuring Security Evaluation Tests (SETs)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Similarly, you can customize the configurations for SETs as well. For example, by editing the Red Queen SET configuration file ``AVISE/avise/configs/SET/languagemodel/multi_turn/red_queen.json``,
you can define if the SET is executed incrementally *(the target model will generate a response after each subsequential prompt)*, or as a template *(only works for target systems that accept a conversation as an input)* and if the SET uses an Adversarial Language Model (ALM).
Additionally, you can define the exact template attack prompts that the SET uses:
Expand All @@ -144,6 +148,10 @@ Additionally, you can define the exact template attack prompts that the SET uses
]
}

Using custom configuration files
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


If you want to use custom configuration files for SETs and/or Connectors, you can do so by giving the paths to the configuration files with ``--SETconf`` and ``--connectorconf`` arguments:

.. code-block:: bash
Expand Down
Loading