Skip to content

Commit a822c1a

Browse files
authored
Merge pull request #35 from ouspg/dev
docs updt
2 parents 08301a6 + 2ea3793 commit a822c1a

3 files changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,8 @@ For example, you can edit the default Ollama Connector configuration file `AVISE
104104
}
105105
```
106106

107+
### Configuring Security Evaluation Tests (SETs)
108+
107109
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`,
108110
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).
109111
Additionally, you can define the exact template attack prompts that the SET uses:
@@ -131,6 +133,8 @@ Additionally, you can define the exact template attack prompts that the SET uses
131133
]
132134
```
133135
136+
### Using custom configuration files
137+
134138
135139
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:
136140

docs/source/installation.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,10 @@ For example, you can edit the default Ollama Connector configuration file ``AVIS
114114
}
115115
}
116116
117+
118+
Configuring Security Evaluation Tests (SETs)
119+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
120+
117121
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``,
118122
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).
119123
Additionally, you can define the exact template attack prompts that the SET uses:
@@ -140,6 +144,9 @@ Additionally, you can define the exact template attack prompts that the SET uses
140144
]
141145
}
142146
147+
Using custom configuration files
148+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
149+
143150
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:
144151

145152
.. code-block:: bash

docs/source/quickstart.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,10 @@ For example, you can edit the default Ollama Connector configuration file ``AVIS
118118
}
119119
}
120120
121+
122+
Configuring Security Evaluation Tests (SETs)
123+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
124+
121125
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``,
122126
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).
123127
Additionally, you can define the exact template attack prompts that the SET uses:
@@ -144,6 +148,10 @@ Additionally, you can define the exact template attack prompts that the SET uses
144148
]
145149
}
146150
151+
Using custom configuration files
152+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
153+
154+
147155
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:
148156

149157
.. code-block:: bash

0 commit comments

Comments
 (0)