Skip to content

Commit

Permalink
Merge pull request #88 from invoke-ai/minor-doc-updates
Browse files Browse the repository at this point in the history
Update installation.md
  • Loading branch information
RyanJDick authored Feb 6, 2024
2 parents 7d6383e + f135e0b commit 56b3254
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions docs/get-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,16 @@
```bash
git clone https://github.com/invoke-ai/invoke-training.git
```
2. (*Optional, but recommended*) Create and activate a python virtual environment by following [these instructions](https://docs.python.org/3/library/venv.html). This creates an isolated environment for `invoke-training` and its dependencies that won't interfere with other python environments on your system.
2. (*Optional, but highly recommended*) Create and activate a python [virtual environment](https://docs.python.org/3/library/venv.html#creating-virtual-environments). This creates an isolated environment for `invoke-training` and its dependencies that won't interfere with other python environments on your system, including any installations of the [local Invoke client](https://www.github.com/invoke-ai/invokeai).
```bash
# Create the new virtual environment in a memorable location by navigating to the folder and running this command
python -m venv invoketraining

# Activate the new virtual environment
Windows: .\invoketraining\Scripts\activate
Linux: source invoketraining/bin/activate

```
3. Install `invoke-training` and its dependencies:
```bash
# A recent version of pip is required, so first upgrade pip:
Expand All @@ -23,7 +32,16 @@ pip install ".[test]" --extra-index-url https://download.pytorch.org/whl/cu121
## Developer Installation
1. Consider forking the repo if you plan to contribute code changes.
2. `git clone` the repo.
3. (*Optional, but recommended*) Create and activate a python virtual environment by following [these instructions](https://docs.python.org/3/library/venv.html). This creates an isolated environment for `invoke-training` and its dependencies that won't interfere with other python environments on your system.
3. (*Optional, but highly recommended*) Create and activate a python [virtual environment](https://docs.python.org/3/library/venv.html#creating-virtual-environments). This creates an isolated environment for `invoke-training` and its dependencies that won't interfere with other python environments on your system, including any installations of the [local Invoke client](https://www.github.com/invoke-ai/invokeai).
```bash
# Create the new virtual environment in a memorable location by navigating to the folder and running this command
python -m venv invoketraining

# Activate the new virtual environment
Windows: .\invoketraining\Scripts\activate
Linux: source invoketraining/bin/activate

```
4. Install `invoke-training` and its dependencies:
```bash
# A recent version of pip is required, so first upgrade pip:
Expand Down

0 comments on commit 56b3254

Please sign in to comment.