DOC restructure installation instructions (microsoft#1127)

romanlutz · web-flow · commit f81f7db0a547 · 2025-10-16T15:44:02.000-07:00
diff --git a/build_scripts/check_links.py b/build_scripts/check_links.py
@@ -19,6 +19,7 @@
     "https://www.anthropic.com/research/many-shot-jailbreaking",  # blocks python requests
     "https://code.visualstudio.com/docs/devcontainers/containers",
     "https://stackoverflow.com/questions/77134272/pip-install-dev-with-pyproject-toml-not-working",
+    "https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers",
 ]
 
 custom_myst_references = ["notebook_tests"]
diff --git a/doc/_toc.yml b/doc/_toc.yml
@@ -7,14 +7,16 @@ chapters:
     - file: cookbooks/2_precomputing_turns
     - file: cookbooks/3_copyright_violations
     - file: cookbooks/4_testing_bias
-  - file: setup/install_pyrit
+  - file: setup/1a_install_conda
     sections:
+    - file: setup/1b_install_docker
     - file: setup/jupyter_setup
     - file: setup/populating_secrets
     - file: setup/use_azure_sql_db
   - file: contributing/README
     sections:
-    - file: contributing/1_installation
+    - file: contributing/1a_install_conda
+    - file: contributing/1b_install_devcontainers
     - file: contributing/2_git
     - file: contributing/3_incorporating_research
     - file: contributing/4_style_guide
diff --git a/doc/code/converters/6_human_converter.ipynb b/doc/code/converters/6_human_converter.ipynb
@@ -21,7 +21,7 @@
     "them; however, you can if you wish to alter the feedback for generating the next prompt.\n",
     "\n",
     "\n",
-    "# Before you begin, ensure you are setup with the correct version of [PyRIT installed](../../setup/install_pyrit.md) and have [secrets configured](../../setup/populating_secrets.md).\n"
+    "# Before you begin, ensure you are setup with the correct version of [PyRIT installed](../../index.md#Installation-Guide and have [secrets configured](../../setup/populating_secrets.md).\n"
    ]
   },
   {
diff --git a/doc/code/converters/6_human_converter.py b/doc/code/converters/6_human_converter.py
@@ -25,7 +25,7 @@
 # them; however, you can if you wish to alter the feedback for generating the next prompt.
 #
 #
-# # Before you begin, ensure you are setup with the correct version of [PyRIT installed](../../setup/install_pyrit.md) and have [secrets configured](../../setup/populating_secrets.md).
+# # Before you begin, ensure you are setup with the correct version of [PyRIT installed](../../index.md#Installation-Guide) and have [secrets configured](../../setup/populating_secrets.md).
 #
 
 # %%
diff --git a/doc/code/executor/attack/context_compliance_attack.ipynb b/doc/code/executor/attack/context_compliance_attack.ipynb
@@ -19,7 +19,7 @@
     "\n",
     "This conversation is sent to the `objective_target`.\n",
     "\n",
-    "Before you begin, ensure you have the correct version of PyRIT installed and have secrets configured as described [here](../../../setup/install_pyrit.md).\n",
+    "Before you begin, ensure you have the correct version of PyRIT installed and have secrets configured as described [here](../../../setup/1a_install_conda.md).\n",
     "\n",
     "The results and intermediate interactions will be saved to memory according to the environment settings. For details, see the [Memory Configuration Guide](../../memory/0_memory.md)."
    ]
diff --git a/doc/code/executor/attack/context_compliance_attack.py b/doc/code/executor/attack/context_compliance_attack.py
@@ -23,7 +23,7 @@
 #
 # This conversation is sent to the `objective_target`.
 #
-# Before you begin, ensure you have the correct version of PyRIT installed and have secrets configured as described [here](../../../setup/install_pyrit.md).
+# Before you begin, ensure you have the correct version of PyRIT installed and have secrets configured as described [here](../../../index.md#Installation-Guide.
 #
 # The results and intermediate interactions will be saved to memory according to the environment settings. For details, see the [Memory Configuration Guide](../../memory/0_memory.md).
 
diff --git a/doc/code/executor/attack/flip_attack.ipynb b/doc/code/executor/attack/flip_attack.ipynb
@@ -13,7 +13,7 @@
     "\n",
     "We replicate the ability to send prompts that match this output: https://github.com/yueliu1999/FlipAttack/blob/main/result/FlipAttack-gpt-4.json. In other words, it sends a system prompt to the target, directing it to unflip the word, and then it flips the malicious prompt.\n",
     "\n",
-    "Before you begin, ensure you are set up with the correct version of PyRIT installed and have secrets configured as described [here](../../../setup/install_pyrit.md).\n",
+    "Before you begin, ensure you are set up with the correct version of PyRIT installed and have secrets configured as described [here](../../../setup/1a_install_conda.md).\n",
     "\n",
     "The results and intermediate interactions will be saved to memory according to the environment settings. For details, see the [Memory Configuration Guide](../../memory/0_memory.md)."
    ]
diff --git a/doc/code/executor/attack/flip_attack.py b/doc/code/executor/attack/flip_attack.py
@@ -15,7 +15,7 @@
 #
 # We replicate the ability to send prompts that match this output: https://github.com/yueliu1999/FlipAttack/blob/main/result/FlipAttack-gpt-4.json. In other words, it sends a system prompt to the target, directing it to unflip the word, and then it flips the malicious prompt.
 #
-# Before you begin, ensure you are set up with the correct version of PyRIT installed and have secrets configured as described [here](../../../setup/install_pyrit.md).
+# Before you begin, ensure you are set up with the correct version of PyRIT installed and have secrets configured as described [here](../../../index.md#Installation-Guide.
 #
 # The results and intermediate interactions will be saved to memory according to the environment settings. For details, see the [Memory Configuration Guide](../../memory/0_memory.md).
 # %%
diff --git a/doc/code/executor/attack/role_play_attack.ipynb b/doc/code/executor/attack/role_play_attack.ipynb
@@ -10,7 +10,7 @@
     "This attack prepends some prompts defined in `role_play_definition`, along with an `adversarial_chat` target LLM to generate the first turns to send. Typically these prompts describe a fictional scenario to attempt and elicit harmful responses.\n",
     "Any converters that you provide will be applied to the prompt that has already been converted by the role play definition (using the provided `adversarial_chat` target). You may see better success if you provide a LLM that has no content moderation or other safety mechanisms. Otherwise, it may refuse to convert the prompt as expected.\n",
     "\n",
-    "Before you begin, ensure you have the correct version of PyRIT installed and have secrets configured as described [here](../../../setup/install_pyrit.md).\n",
+    "Before you begin, ensure you have the correct version of PyRIT installed and have secrets configured as described [here](../../../setup/1a_install_conda.md).\n",
     "\n",
     "The results and intermediate interactions will be saved to memory according to the environment settings. For details, see the [Memory Configuration Guide](../../memory/0_memory.md)."
    ]
diff --git a/doc/code/executor/attack/role_play_attack.py b/doc/code/executor/attack/role_play_attack.py
@@ -14,7 +14,7 @@
 # This attack prepends some prompts defined in `role_play_definition`, along with an `adversarial_chat` target LLM to generate the first turns to send. Typically these prompts describe a fictional scenario to attempt and elicit harmful responses.
 # Any converters that you provide will be applied to the prompt that has already been converted by the role play definition (using the provided `adversarial_chat` target). You may see better success if you provide a LLM that has no content moderation or other safety mechanisms. Otherwise, it may refuse to convert the prompt as expected.
 #
-# Before you begin, ensure you have the correct version of PyRIT installed and have secrets configured as described [here](../../../setup/install_pyrit.md).
+# Before you begin, ensure you have the correct version of PyRIT installed and have secrets configured as described [here](../../../index.md#Installation-Guide.
 #
 # The results and intermediate interactions will be saved to memory according to the environment settings. For details, see the [Memory Configuration Guide](../../memory/0_memory.md).
 
diff --git a/doc/contributing/11_release_process.md b/doc/contributing/11_release_process.md
@@ -36,11 +36,13 @@ there should be any postfixes on the release version.
 With that in mind, the reason for the release and the set of changes
 that happened since the last release will influence the new version number.
 
-## 2. Update __init__.py and pyproject.toml
+## 2. Update the version
+
+### __init__.py and pyproject.toml
 
 Set the version in `pyproject.toml` and `pyrit/__init__.py` to the version established in step 1.
 
-## Update README File
+### Update README File
 
 The README file is published to PyPI and also needs to be updated so the
 links work properly. Note: There may not be any links to update, but it is
@@ -144,13 +146,19 @@ If successful, it will print
 > View at:
   https://pypi.org/project/pyrit/x.y.z/
 
+## 7. Update main
+
 After the release is on PyPI, make sure to create a PR for the `main` branch
-where the only change is the version increase in `__init__.py` (while keeping
-suffix `.dev0`). The PR should be made from your fork and should be a different
-branch than the releases branch you created earlier.
+where the only changes are:
+
+- the version increase in `__init__.py` (while keeping suffix `.dev0`).
+- Search for the previous release version in the codebase and replace any occurrences with the new version
+  (without `.dev0`). For example, some installation pages refer to the latest release.
+
+The PR should be made from your fork and should be a different branch than the releases branch you created earlier.
 This should be something like `x.y.z+1.dev0`.
 
-## 7. Create GitHub Release
+## 8. Create GitHub Release
 
 Finally, go to the [releases page](https://github.com/Azure/PyRIT/releases), select "Draft a new release" and the "tag"
 for which you want to create the release notes. It should match the version that you just released
diff --git a/doc/contributing/1a_install_conda.md b/doc/contributing/1a_install_conda.md
@@ -1,14 +1,19 @@
-# 1. Install
+# 1. Local Installation with Conda/Python
 
 ## Choose Your Setup Approach
 
-You can set up PyRIT in one of two ways:
-1. Local Installation with Conda/Python (see [Local Installation with Conda/Python](#local-installation-with-condapython)).
-2. Using DevContainers (see [DevContainers Setup in Visual Studio Code](#devcontainers-setup-in-visual-studio-code)).
+You can set up PyRIT for development in one of two ways:
 
-## Local Installation with Conda/Python
+1. **Local Installation with Conda/Python** (this page) - Install PyRIT in editable mode on your machine
+2. **[DevContainers in VS Code](./1b_install_devcontainers.md)** - Use a pre-configured Docker container with VS Code
 
-To install PyRIT as a library, the simplest way to do it is just `pip install pyrit`. This is documented [here](../setup/install_pyrit.md).
+```{note}
+**Development Version:** Contributor installations use the **latest development code** from the `main` branch, not a stable release. The notebooks in your cloned repository will match your code version. This documentation website also shows the main branch version.
+```
+
+## Overview
+
+To install PyRIT as a library, the simplest way to do it is just `pip install pyrit`. This is documented [here](../setup/1a_install_conda.md).
 
 However, there are many reasons to install as a contributor. Yes, of course, if you want to contribute. But also because of the nature of the tool, it is often the case that targets, attacks, converters, core, etc. code needs to be modified. This section walks through how to install PyRIT as a contributor.
 
@@ -75,7 +80,7 @@ This is a guide for how to install PyRIT into a `conda` environment.
    ```bash
    pip install -e '.[dev]'
    ```
-   If you plan to use the [Playwright integration 3](../code/targets/playwright_target.py), install with the playwright extra:
+   If you plan to use the [Playwright integration](../code/targets/playwright_target.py), install with the playwright extra:
    ```bash
    pip install -e '.[dev,playwright]'
    ```
@@ -98,31 +103,20 @@ Alternatively, you can run the tool directly on Windows using PowerShell.
 
 **Visual Studio Code** is the code editor of choice for the AI Red Team: Download [here](https://code.visualstudio.com/Download).
 
-## DevContainers Setup in Visual Studio Code
-### Prerequisites
-* Install **Docker** (Docker Desktop if you are using Windows)
-* Install [**DevContainer**](https://code.visualstudio.com/docs/devcontainers/containers) extension in VS Code
-
-You can also follow the **Installation** section on [Developing inside a Container](https://code.visualstudio.com/docs/devcontainers/containers)
-
-### Run the Container
-Press `Ctrl + Shift + P` to open VS Code Command Palette and type `Dev Containers: Reopen in Container`
-![DevContainer in VS Code Commands Menu](images/DevContainer-vscode.png)
-
-### Running Jupyter Notebooks in VS Code
-
-_note:_ When constructing a pull request, notebooks should not be edited directly. Instead, edit the corresponding `.py` file. See [notebooks.md](8_notebooks.md) for more details.
-
-## Selecting a Kernel
+## Selecting a Jupyter Kernel
 
 With a Jupyter Notebook (.ipynb file) window open, in the top search bar of VS Code, type `>Notebook: Select Notebook Kernel` > `Python Environments...` to choose the `pyrit-dev` kernel when executing code in the notebooks, like those in `examples`. You can also choose a kernel with the "Select Kernel" button on the top-right corner of a Notebook.
 
 This will be the kernel that runs all code examples in Python Notebooks.
 
-### Jupyter Variables
+### Viewing Jupyter Variables
 
 To view the variables that are populated by code examples, go to `View > Output > Jupyter`.
 
+```{note}
+When constructing a pull request, notebooks should not be edited directly. Instead, edit the corresponding `.py` file. See [notebooks.md](8_notebooks.md) for more details.
+```
+
 ## Populating Secrets
 
 See [this](../setup/populating_secrets.md) for more details on populating secrets.
diff --git a/doc/contributing/1b_install_devcontainers.md b/doc/contributing/1b_install_devcontainers.md
@@ -0,0 +1,152 @@
+# DevContainers Setup in Visual Studio Code
+
+DevContainers provide a pre-configured development environment for PyRIT that ensures consistency across all contributors. This is the recommended setup for contributors using Visual Studio Code.
+
+```{note}
+**Development Version:** This setup uses the **latest development code** from the main branch, not a stable release. The notebooks in your cloned repository will match your code version.
+```
+
+## Who Should Use DevContainers?
+
+✅ **Use DevContainers if you:**
+- Use Visual Studio Code as your editor. (Note that DevContainers can be used independently but our installation guide leverages VS Code since it's seamless.)
+- Want a pre-configured development environment
+- Want consistency with other contributors
+- Prefer not to manage Python environments manually
+- Need all development tools and extensions pre-installed
+
+❌ **Consider [local installation](./1a_install_conda.md) if you:**
+- Use a different IDE or editor
+- Prefer full control over your development environment
+- Need to customize your setup beyond what DevContainers offer
+
+## Prerequisites
+
+Before starting, install:
+
+1. **Docker** (Docker Desktop if you are using Windows)
+   - [Download Docker](https://docs.docker.com/get-docker/)
+
+2. **Visual Studio Code**
+   - [Download VS Code](https://code.visualstudio.com/Download)
+
+3. **DevContainers Extension** in VS Code
+   - [Install DevContainer Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
+
+You can also follow the **Installation** section on [Developing inside a Container](https://code.visualstudio.com/docs/devcontainers/containers) for more details.
+
+## Setup Steps
+
+### 1. Clone the PyRIT Repository
+
+```bash
+git clone https://github.com/Azure/PyRIT
+cd PyRIT
+```
+
+### 2. Open in VS Code
+
+Open the PyRIT folder in Visual Studio Code:
+
+```bash
+code .
+```
+
+### 3. Reopen in Container
+
+Make sure Docker is running first, for example, by starting "Docker Desktop."
+
+Press `Ctrl + Shift + P` (or `Cmd + Shift + P` on macOS) to open the VS Code Command Palette, then type and select:
+
+```
+Dev Containers: Reopen in Container
+```
+
+![DevContainer in VS Code Commands Menu](images/DevContainer-vscode.png)
+
+VS Code will:
+1. Build the development container (this may take several minutes the first time)
+2. Install all dependencies
+3. Configure the development environment
+4. Reopen VS Code inside the container
+
+```{tip}
+The first build takes longer as Docker downloads and configures everything. Subsequent opens will be much faster!
+```
+
+## Working with Jupyter Notebooks
+
+### Selecting a Kernel
+
+When working with Jupyter Notebooks (`.ipynb` files):
+
+1. Open a notebook file in VS Code
+2. Click the **"Select Kernel"** button in the top-right corner of the notebook
+3. Choose **"Python Environments..."**
+4. Select the **`pyrit-dev`** kernel
+
+Alternatively, you can use the Command Palette:
+- Press `Ctrl + Shift + P` (or `Cmd + Shift + P` on macOS)
+- Type `>Notebook: Select Notebook Kernel`
+- Choose **"Python Environments..."** > **`pyrit-dev`**
+
+This kernel will run all code examples in Python Notebooks.
+
+### Viewing Jupyter Variables
+
+To view variables populated by code examples:
+
+1. Go to **View** > **Output**
+2. Select **Jupyter** from the dropdown menu
+
+```{important}
+**Note for Contributors:** When constructing a pull request, notebooks should not be edited directly. Instead, edit the corresponding `.py` file. See [Working with Notebooks](8_notebooks.md) for more details.
+```
+
+## Populating Secrets
+
+After setting up your DevContainer, configure your API keys and secrets:
+
+See [Populating Secrets](../setup/populating_secrets.md) for detailed instructions.
+
+## Common DevContainer Operations
+
+### Rebuild the Container
+
+If you need to rebuild the container (e.g., after dependency changes):
+
+1. Press `Ctrl + Shift + P` (or `Cmd + Shift + P` on macOS)
+2. Type and select: `Dev Containers: Rebuild Container`
+
+### Reopen Locally
+
+To exit the container and return to your local environment:
+
+1. Press `Ctrl + Shift + P` (or `Cmd + Shift + P` on macOS)
+2. Type and select: `Dev Containers: Reopen Folder Locally`
+
+## Troubleshooting
+
+### Container Build Fails
+
+**Problem**: DevContainer fails to build
+
+**Solutions**:
+1. Ensure Docker is running
+2. Check that you have sufficient disk space
+3. Try rebuilding: `Dev Containers: Rebuild Container Without Cache`
+
+### Extension Not Loading
+
+**Problem**: VS Code extensions don't load in the container
+
+**Solution**: Check the `.devcontainer/devcontainer.json` file to ensure extensions are listed. Rebuild the container if needed.
+
+### Performance Issues
+
+**Problem**: Container runs slowly
+
+**Solutions**:
+1. Allocate more resources to Docker in Docker Desktop settings
+2. On Windows, ensure you're using WSL 2 backend for better performance
+3. Close unnecessary applications to free up system resources
diff --git a/doc/index.md b/doc/index.md
diff --git a/doc/setup/1a_install_conda.md b/doc/setup/1a_install_conda.md
diff --git a/doc/setup/1b_install_docker.md b/doc/setup/1b_install_docker.md
diff --git a/doc/setup/install_pyrit.md b/doc/setup/install_pyrit.md
diff --git a/docker/README.md b/docker/README.md

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@`
`19`	`19`	`"https://www.anthropic.com/research/many-shot-jailbreaking", # blocks python requests`
`20`	`20`	`"https://code.visualstudio.com/docs/devcontainers/containers",`
`21`	`21`	`"https://stackoverflow.com/questions/77134272/pip-install-dev-with-pyproject-toml-not-working",`
	`22`	`+ "https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers",`
`22`	`23`	`]`
`23`	`24`
`24`	`25`	`custom_myst_references = ["notebook_tests"]`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`"them; however, you can if you wish to alter the feedback for generating the next prompt.\n",`
`22`	`22`	`"\n",`
`23`	`23`	`"\n",`
`24`		`- "# Before you begin, ensure you are setup with the correct version of [PyRIT installed](../../setup/install_pyrit.md) and have [secrets configured](../../setup/populating_secrets.md).\n"`
	`24`	`+ "# Before you begin, ensure you are setup with the correct version of [PyRIT installed](../../index.md#Installation-Guide and have [secrets configured](../../setup/populating_secrets.md).\n"`
`25`	`25`	`]`
`26`	`26`	`},`
`27`	`27`	`{`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@`
`25`	`25`	`# them; however, you can if you wish to alter the feedback for generating the next prompt.`
`26`	`26`	`#`
`27`	`27`	`#`
`28`		`-# # Before you begin, ensure you are setup with the correct version of [PyRIT installed](../../setup/install_pyrit.md) and have [secrets configured](../../setup/populating_secrets.md).`
	`28`	`+# # Before you begin, ensure you are setup with the correct version of [PyRIT installed](../../index.md#Installation-Guide) and have [secrets configured](../../setup/populating_secrets.md).`
`29`	`29`	`#`
`30`	`30`
`31`	`31`	`# %%`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`"\n",`
`20`	`20`	"This conversation is sent to the `objective_target`.\n",
`21`	`21`	`"\n",`
`22`		`- "Before you begin, ensure you have the correct version of PyRIT installed and have secrets configured as described [here](../../../setup/install_pyrit.md).\n",`
	`22`	`+ "Before you begin, ensure you have the correct version of PyRIT installed and have secrets configured as described [here](../../../setup/1a_install_conda.md).\n",`
`23`	`23`	`"\n",`
`24`	`24`	`"The results and intermediate interactions will be saved to memory according to the environment settings. For details, see the [Memory Configuration Guide](../../memory/0_memory.md)."`
`25`	`25`	`]`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`#`
`24`	`24`	# This conversation is sent to the `objective_target`.
`25`	`25`	`#`
`26`		`-# Before you begin, ensure you have the correct version of PyRIT installed and have secrets configured as described [here](../../../setup/install_pyrit.md).`
	`26`	`+# Before you begin, ensure you have the correct version of PyRIT installed and have secrets configured as described [here](../../../index.md#Installation-Guide.`
`27`	`27`	`#`
`28`	`28`	`# The results and intermediate interactions will be saved to memory according to the environment settings. For details, see the [Memory Configuration Guide](../../memory/0_memory.md).`
`29`	`29`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`"\n",`
`14`	`14`	`"We replicate the ability to send prompts that match this output: https://github.com/yueliu1999/FlipAttack/blob/main/result/FlipAttack-gpt-4.json. In other words, it sends a system prompt to the target, directing it to unflip the word, and then it flips the malicious prompt.\n",`
`15`	`15`	`"\n",`
`16`		`- "Before you begin, ensure you are set up with the correct version of PyRIT installed and have secrets configured as described [here](../../../setup/install_pyrit.md).\n",`
	`16`	`+ "Before you begin, ensure you are set up with the correct version of PyRIT installed and have secrets configured as described [here](../../../setup/1a_install_conda.md).\n",`
`17`	`17`	`"\n",`
`18`	`18`	`"The results and intermediate interactions will be saved to memory according to the environment settings. For details, see the [Memory Configuration Guide](../../memory/0_memory.md)."`
`19`	`19`	`]`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`#`
`16`	`16`	`# We replicate the ability to send prompts that match this output: https://github.com/yueliu1999/FlipAttack/blob/main/result/FlipAttack-gpt-4.json. In other words, it sends a system prompt to the target, directing it to unflip the word, and then it flips the malicious prompt.`
`17`	`17`	`#`
`18`		`-# Before you begin, ensure you are set up with the correct version of PyRIT installed and have secrets configured as described [here](../../../setup/install_pyrit.md).`
	`18`	`+# Before you begin, ensure you are set up with the correct version of PyRIT installed and have secrets configured as described [here](../../../index.md#Installation-Guide.`
`19`	`19`	`#`
`20`	`20`	`# The results and intermediate interactions will be saved to memory according to the environment settings. For details, see the [Memory Configuration Guide](../../memory/0_memory.md).`
`21`	`21`	`# %%`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	"This attack prepends some prompts defined in `role_play_definition`, along with an `adversarial_chat` target LLM to generate the first turns to send. Typically these prompts describe a fictional scenario to attempt and elicit harmful responses.\n",
`11`	`11`	"Any converters that you provide will be applied to the prompt that has already been converted by the role play definition (using the provided `adversarial_chat` target). You may see better success if you provide a LLM that has no content moderation or other safety mechanisms. Otherwise, it may refuse to convert the prompt as expected.\n",
`12`	`12`	`"\n",`
`13`		`- "Before you begin, ensure you have the correct version of PyRIT installed and have secrets configured as described [here](../../../setup/install_pyrit.md).\n",`
	`13`	`+ "Before you begin, ensure you have the correct version of PyRIT installed and have secrets configured as described [here](../../../setup/1a_install_conda.md).\n",`
`14`	`14`	`"\n",`
`15`	`15`	`"The results and intermediate interactions will be saved to memory according to the environment settings. For details, see the [Memory Configuration Guide](../../memory/0_memory.md)."`
`16`	`16`	`]`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	# This attack prepends some prompts defined in `role_play_definition`, along with an `adversarial_chat` target LLM to generate the first turns to send. Typically these prompts describe a fictional scenario to attempt and elicit harmful responses.
`15`	`15`	# Any converters that you provide will be applied to the prompt that has already been converted by the role play definition (using the provided `adversarial_chat` target). You may see better success if you provide a LLM that has no content moderation or other safety mechanisms. Otherwise, it may refuse to convert the prompt as expected.
`16`	`16`	`#`
`17`		`-# Before you begin, ensure you have the correct version of PyRIT installed and have secrets configured as described [here](../../../setup/install_pyrit.md).`
	`17`	`+# Before you begin, ensure you have the correct version of PyRIT installed and have secrets configured as described [here](../../../index.md#Installation-Guide.`
`18`	`18`	`#`
`19`	`19`	`# The results and intermediate interactions will be saved to memory according to the environment settings. For details, see the [Memory Configuration Guide](../../memory/0_memory.md).`
`20`	`20`