Skip to content

Commit

Permalink
Update docs for #1125 (#1128)
Browse files Browse the repository at this point in the history
  • Loading branch information
Josh-XT authored Mar 6, 2024
1 parent 864dc50 commit 5cae2c4
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 26 deletions.
38 changes: 14 additions & 24 deletions docs/1-Getting started/2-Install Options.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,18 @@
### Install Options
You will be prompted to choose an install option. The first 3 options require you to have Docker installed. The options are as follows:
# Install Options

![image](https://github.com/Josh-XT/AGiXT/assets/102809327/944c9600-d67f-45da-ac1e-715e4c9d3912)
You will be prompted to choose an option when you run `AGiXT.ps1`. If you're not actively developing on the AGiXT platform, I recommend choosing option 1. The other options are unsupported and may break at any time as they use the development branch of AGiXT.

1. **Run AGiXT (Recommended)**
- This option will run [AGiXT](https://github.com/Josh-XT/AGiXT) and the [AGiXT Streamlit Web UI](https://github.com/AGiXT/streamlit) in Docker containers. This is the recommended option for most users.
2. **Run AGiXT with Text Generation Web UI (NVIDIA Only)**
- This option is only available if you have an NVIDIA GPU and will not work if you do not.
- This option will run [AGiXT](https://github.com/Josh-XT/AGiXT), the [AGiXT Streamlit Web UI](https://github.com/AGiXT/streamlit), and the [Oobabooga Text Generation Web UI](https://github.com/oobabooga/text-generation-webui) in Docker containers. This is the recommended option for most users who want to use local models on GPU. You will need a powerful video card to run this option. We highly recommend reviewing their documentation before using this option unless you have run local models on GPU before.
3. **Run AGiXT with Text Generation Web UI and Stable Diffusion (NVIDIA Only)**
- All of the same as option 2, except this also launches an [AUTOMATIC1111 Stable Diffusion Web UI](https://github.com/AUTOMATIC1111/stable-diffusion-webui) as well.

**Developer Only Options (Not recommended or supported):**
```bash
1. Run AGiXT (Stable - Recommended!)
2. Run AGiXT (Development)
3. Run Backend Only (Development)
4. Exit
Enter your choice:
```

4. **Run AGiXT from Main Branch**
1. **Run AGiXT (Stable - Recommended)**
- This option will run [AGiXT](https://github.com/Josh-XT/AGiXT) and the [AGiXT Streamlit Web UI](https://github.com/AGiXT/streamlit) in Docker containers. This is the recommended option for most users.
2. **Run AGiXT (Development)**
- This option is like option 1, except it pulls from the main branch instead of the latest release version of AGiXT. This is not recommended or supported due to it being unstable and may break at any time.
5. **Run AGiXT from Main Branch + Addons (NVIDIA Only)**
- This option is like option 3, except it pulls from the main branch instead of the latest release version of AGiXT. This is not recommended or supported due to it being unstable and may break at any time.
6. **Run AGiXT without Docker**
- This option will run AGiXT without Docker. This is not recommended or supported due to it being unstable and may break at any time.

**Manage:**

7. **Enable/Disable Automatic Updates**
- This option will enable or disable automatic updates for AGiXT.
8. **Exit**
- This option will exit the installer.
3. **Run AGiXT Back End Only (Development)**
- This option is like option 2, except it only runs the back end of AGiXT from the main branch.
2 changes: 0 additions & 2 deletions docs/1-Getting started/Screenshots.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
![image](https://github.com/Josh-XT/AGiXT/assets/102809327/944c9600-d67f-45da-ac1e-715e4c9d3912)

![Screenshot from 2023-08-10 16-13-15](https://github.com/Josh-XT/AGiXT/assets/102809327/e4d0eb5a-06e8-460f-b915-7ab9fb0d6114)

![Screenshot from 2023-08-10 16-13-27](https://github.com/Josh-XT/AGiXT/assets/102809327/cbc30e69-733c-4ceb-801b-20dfc377ac81)
Expand Down

0 comments on commit 5cae2c4

Please sign in to comment.