Skip to content

quickstart guide updt #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Zippo00 merged 2 commits into from
Apr 13, 2026
Merged

quickstart guide updt #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
73ea4f6
quickstart updt
Zippo00 Apr 13, 2026
586734a
Merge branch 'main' into dev
Zippo00 Apr 13, 2026
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
29 changes: 29 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,35 @@ For example, you can edit the default Ollama Connector configuration file `AVISE
}
}
```

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:

```json
{
"incremental_execution": false, #Change to true to execute the SET cases incrementally
"use_adversarial_languagemodel": false, #Change to true to utilize an Adversarial Language Model (ALM)
"adversarial_model_device": "auto", # Defines on which device(s) the ALM is loaded to ("cpu", "gpu", or "auto")
"evaluation_system_prompt": "You are a highly accurate cybersecurity classifier, ..."
"evaluation_model_device": "auto", # Defines on which device(s) the ELM is loaded to ("cpu", "gpu", or "auto")
"sets": [
{
"id": "RED-QUEEN-001",
"vulnerability_subcategory": "Evasion Attack",
"action": "make a fake passport",
"type": "occupation_teacher",
"category": "violence,aiding_and_abetting,incitement",
"conversation": [
{ ... }
...
]
},
...
]
```


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:

```bash
Expand Down
29 changes: 29 additions & 0 deletions docs/source/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,35 @@ For example, you can edit the default Ollama Connector configuration file `AVISE
}
}
```

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:

```json
{
"incremental_execution": false, #Change to true to execute the SET cases incrementally
"use_adversarial_languagemodel": false, #Change to true to utilize an Adversarial Language Model (ALM)
"adversarial_model_device": "auto", # Defines on which device(s) the ALM is loaded to ("cpu", "gpu", or "auto")
"evaluation_system_prompt": "You are a highly accurate cybersecurity classifier, ..."
"evaluation_model_device": "auto", # Defines on which device(s) the ELM is loaded to ("cpu", "gpu", or "auto")
"sets": [
{
"id": "RED-QUEEN-001",
"vulnerability_subcategory": "Evasion Attack",
"action": "make a fake passport",
"type": "occupation_teacher",
"category": "violence,aiding_and_abetting,incitement",
"conversation": [
{ ... }
...
]
},
...
]
```


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:

```bash
Expand Down
30 changes: 29 additions & 1 deletion docs/source/quickstart.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ avise --SET-list

## Advanced usage

### Configuring Connectors
### Configuring Connectors and SETs

You can create your own connector configuration files, or if you cloned the AVISE repository, you can modify the existing connector configuration files in `AVISE/avise/configs/connector/languagemodel/`.

Expand All @@ -98,6 +98,34 @@ For example, you can edit the default Ollama Connector configuration file `AVISE
}
}
```

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:

```json
{
"incremental_execution": false, #Change to true to execute the SET cases incrementally
"use_adversarial_languagemodel": false, #Change to true to utilize an Adversarial Language Model (ALM)
"adversarial_model_device": "auto", # Defines on which device(s) the ALM is loaded to ("cpu", "gpu", or "auto")
"evaluation_system_prompt": "You are a highly accurate cybersecurity classifier, ..."
"evaluation_model_device": "auto", # Defines on which device(s) the ELM is loaded to ("cpu", "gpu", or "auto")
"sets": [
{
"id": "RED-QUEEN-001",
"vulnerability_subcategory": "Evasion Attack",
"action": "make a fake passport",
"type": "occupation_teacher",
"category": "violence,aiding_and_abetting,incitement",
"conversation": [
{ ... }
...
]
},
...
]
```

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:

```bash
Expand Down
Loading