TroubleChute Script Hub

# Copyright (C) 2023 TroubleChute (Wesley Pyburn)
# Licensed under the GNU General Public License v3.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.gnu.org/licenses/gpl-3.0.en.html
#
#    This program is free software: you can redistribute it and/or modify
#    it under the terms of the GNU General Public License as published by
#    the Free Software Foundation, either version 3 of the License, or
#    (at your option) any later version.
#    
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#    
#    You should have received a copy of the GNU General Public License
#    along with this program.  If not, see .
#
# ----------------------------------------
# This script:
# 1. Install Chocolatey
# 2. Install or update Git if not already installed
# 3. Install aria2c to make the model downloads MUCH faster
# 4. Install Build Tools
# 5. Install CUDA and cuDNN
# 6. Check if Conda or Python is installed
# 7 Check if has privateGPT directory ($TCHT\privateGPT) (Default C:\TCHT\privateGPT)
# - Clone https://github.com/imartinez/privateGPT
# 8. Download a model
# 9. Set up the models in env:
# 10. Create Launcher files
# 11. Create desktop shortcuts?
# 12. Launch privateGPT
# ----------------------------------------

Write-Host "-----------------------------------------------" -ForegroundColor Cyan
Write-Host "Welcome to TroubleChute's privateGPT installer!" -ForegroundColor Cyan
Write-Host "privateGPT as well as all of its other dependencies and a model should now be installed..." -ForegroundColor Cyan
Write-Host "[Version 2023-05-22]" -ForegroundColor Cyan
Write-Host "`nThis script is provided AS-IS without warranty of any kind. See https://tc.ht/privacy & https://tc.ht/terms."
Write-Host "Consider supporting these install scripts: https://tc.ht/support" -ForegroundColor Green
Write-Host "-----------------------------------------------`n`n" -ForegroundColor Cyan

Set-Variable ProgressPreference SilentlyContinue # Remove annoying yellow progress bars when doing Invoke-WebRequest for this session

if (-not ([Security.Principal.WindowsPrincipal] [Security.Principal.WindowsIdentity]::GetCurrent()).IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator)) {
    Write-Host "This script needs to be run as an administrator.`nProcess can try to continue, but will likely fail. Press Enter to continue..." -ForegroundColor Red
    Read-Host
}

# Allow importing remote functions
iex (irm Import-RemoteFunction.tc.ht)
Import-RemoteFunction("Get-GeneralFuncs.tc.ht")

Import-FunctionIfNotExists -Command Get-TCHTPath -ScriptUri "Get-TCHTPath.tc.ht"
$TCHT = Get-TCHTPath -Subfolder "privateGPT"

# If user chose to install this program in another path, create a symlink for easy access and management.
$isSymlink = Sync-ProgramFolder -ChosenPath $TCHT -Subfolder "privateGPT"

# Then CD into $TCHT\
Set-Location "$TCHT\"


# 1. Install Chocolatey
Clear-ConsoleScreen
Write-Host "Installing Chocolatey..." -ForegroundColor Cyan
Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))

# 2. Install or update Git if not already installed
Clear-ConsoleScreen
Write-Host "Installing Git..." -ForegroundColor Cyan
iex (irm install-git.tc.ht)

# Import function to reload without needing to re-open Powershell
iex (irm refreshenv.tc.ht)

# 3. Install aria2c to make the model downloads MUCH faster
Clear-ConsoleScreen
Write-Host "Installing aria2c (Faster model download)..." -ForegroundColor Cyan
choco upgrade aria2 -y
Update-SessionEnvironment

# 4. Install Build Tools
Clear-ConsoleScreen
Write-Host "Installing Microsoft Build Tools..." -ForegroundColor Cyan
iex (irm buildtools.tc.ht)

Import-FunctionIfNotExists -Command Get-TCHTPath -ScriptUri "Get-TCHTPath.tc.ht"
$TCHT = Get-TCHTPath

# 5. Install CUDA and cuDNN
if ((Get-CimInstance Win32_VideoController).Name -like "*Nvidia*") {
    Import-FunctionIfNotExists -Command Install-CudaAndcuDNN -ScriptUri "Install-Cuda.tc.ht"
    Install-CudaAndcuDNN -CudaVersion "11.8" -CudnnOptional $true
}

# 6. Check if Conda or Python is installed
# Check if Conda is installed
Import-FunctionIfNotExists -Command Get-UseConda -ScriptUri "Get-Python.tc.ht"

# Check if Conda is installed
$condaFound = Get-UseConda -Name "privateGPT" -EnvName "pgpt" -PythonVersion "3.10.11"

# Get Python command (eg. python, python3) & Check for compatible version
if ($condaFound) {
    conda activate "pgpt"
    $python = "python"
} else {
    $python = Get-Python -PythonRegex 'Python ([3].[1][0-1].[6-9]|3.10.1[0-1])' -PythonRegexExplanation "Python version is not between 3.10.6 and 3.10.11." -PythonInstallVersion "3.10.11" -ManualInstallGuide "https://github.com/imartinez/privateGPT#environment-setup"
    if ($python -eq "miniconda") {
        $python = "python"
        $condaFound = $true
    }
}


# 7. Check if has privateGPT directory ($TCHT\privateGPT) (Default C:\TCHT\privateGPT)
Clear-ConsoleScreen
if ((Test-Path -Path "$TCHT\privateGPT") -and -not $isSymlink) {
    Write-Host "The 'privateGPT' folder already exists. We'll pull the latest updates (git pull)" -ForegroundColor Green
    Set-Location "$TCHT\privateGPT"
    git pull
    if ($LASTEXITCODE -eq 128) {
        Write-Host "Could not find existing git repository. Cloning privateGPT...`n`n"
        git clone https://github.com/imartinez/privateGPT.git .
    }
} else {
    Write-Host "I'll start by installing privateGPT first, then we'll get to the model...`n`n"
    
    if (!(Test-Path -Path "$TCHT\privateGPT")) {
        New-Item -ItemType Directory -Path "$TCHT\privateGPT" | Out-Null
    }
    Set-Location "$TCHT\privateGPT"

    git clone https://github.com/imartinez/privateGPT.git .
}

Import-FunctionIfNotExists -Command Get-Aria2Files -ScriptUri "File-DownloadMethods.tc.ht"
function Get-VincunaCPU13B {
    # Download Vicuna 13B
    Write-Host "Downloading Vicuna 13B" -ForegroundColor Yellow
    $blob = "https://huggingface.co/eachadea/ggml-vicuna-13b-1.1/resolve/main"
    $outputPath = "models"
    Write-Host "Downloading: eachadea/ggml-vicuna-13b-1.1 (CPU model)" -ForegroundColor Cyan
    $files = @(
        "ggml-vic13b-q5_1.bin"
    )

    Get-Aria2Files -Url $blob -OutputPath $outputPath -Files $files
    Write-Host "Done" -ForegroundColor Yellow
}

function Get-VincunaUncensoredCPU13B {
    # Download Vicuna 13B
    Write-Host "Downloading Vicuna 13B" -ForegroundColor Yellow
    $blob = "https://huggingface.co/eachadea/ggml-vicuna-13b-1.1/resolve/main"
    $outputPath = "models"
    Write-Host "Downloading: eachadea/ggml-vicuna-13b-1.1 (CPU model)" -ForegroundColor Cyan
    $files = @(
        "ggml-vic13b-uncensored-q4_0.bin"
    )

    Get-Aria2Files -Url $blob -OutputPath $outputPath -Files $files
    Write-Host "Done" -ForegroundColor Yellow
}

function Get-VicunaCPU7B {
    # Download Vicuna 7B
    Write-Host "Downloading Vicuna 7B" -ForegroundColor Yellow
    $blob = "https://huggingface.co/eachadea/ggml-vicuna-7b-1.1/resolve/main"
    $outputPath = "models"
    Write-Host "Downloading: eachadea/ggml-vicuna-7b-1.1 (CPU model)" -ForegroundColor Cyan
    $files = @(
        "ggml-vic7b-q4_0.bin"
    )

    Get-Aria2Files -Url $blob -OutputPath $outputPath -Files $files
    Write-Host "Done" -ForegroundColor Yellow
}

function Get-VicunaUncensoredCPU7B {
    # Download Vicuna 7B
    Write-Host "Downloading Vicuna 7B" -ForegroundColor Yellow
    $blob = "https://huggingface.co/eachadea/ggml-vicuna-7b-1.1/resolve/main"
    $outputPath = "models"
    Write-Host "Downloading: eachadea/ggml-vicuna-7b-1.1 (CPU model)" -ForegroundColor Cyan
    $files = @(
        "ggml-vic7b-uncensored-q4_0.bin"
    )

    Get-Aria2Files -Url $blob -OutputPath $outputPath -Files $files
    Write-Host "Done" -ForegroundColor Yellow
}

function Get-KoalaCPU7B {
    # Download Koala 7B
    Write-Host "Downloading Koala 7B" -ForegroundColor Yellow
    $blob = "https://huggingface.co/TheBloke/koala-7B-GGML/resolve/main"
    $outputPath = "models"
    Write-Host "Downloading: TheBloke/koala-7B-GGML(CPU model)" -ForegroundColor Cyan
    $files = @(
        "koala-7B.ggmlv3.q4_0.bin"
    )

    Get-Aria2Files -Url $blob -OutputPath $outputPath -Files $files
    Write-Host "Done" -ForegroundColor Yellow
}

function Get-KoalaCPU13B {
    # Download Koala 7B
    Write-Host "Downloading Koala 13B" -ForegroundColor Yellow
    $blob = "https://huggingface.co/TheBloke/koala-13B-GGML/resolve/main"
    $outputPath = "models"
    Write-Host "Downloading: TheBloke/koala-13B-GGML(CPU model)" -ForegroundColor Cyan
    $files = @(
        "koala-13B.ggmlv3.q4_0.bin"
    )

    Get-Aria2Files -Url $blob -OutputPath $outputPath -Files $files
    Write-Host "Done" -ForegroundColor Yellow
}

function Get-Gpt4All {
    # Download Koala 7B
    Write-Host "Downloading GPT4ALL-J v1.3 (Default model)" -ForegroundColor Yellow
    $url = "https://gpt4all.io/models/ggml-gpt4all-j-v1.3-groovy.bin"
    $outputPath = "models/ggml-gpt4all-j-v1.3-groovy.bin"
    Get-Aria2File -Url $url -OutputPath $outputPath
    Write-Host "Done" -ForegroundColor Yellow
}

# - Install requirements.txt
if ($condaFound -and ((Get-CimInstance Win32_VideoController).Name -like "*Nvidia*")) {
    conda install cudatoolkit -y
}

&$python -m pip install -r requirements.txt
&$python -m pip install requests "urllib3<2"

# Create models folder
if (!(Test-Path -Path "models")) {
    New-Item -ItemType Directory -Path "models" | Out-Null
}

# Rename env file
if (Test-Path "example.env") {
    # Rename the file
    Rename-Item -Path "example.env" -NewName ".env" -Force
}

# 8. Download a model
do {
    Clear-ConsoleScreen
    Write-Host "Which model would you like to download and use:" -ForegroundColor Cyan
    Write-Host -NoNewline "Vicuna 13B: " -ForegroundColor Red
    Write-Host "1" -ForegroundColor Green
    Write-Host -NoNewline "Vicuna 13B Uncensored: " -ForegroundColor Red
    Write-Host "2" -ForegroundColor Green
    Write-Host -NoNewline "Vicuna 7B: " -ForegroundColor Red
    Write-Host "3" -ForegroundColor Green
    Write-Host -NoNewline "Vicuna 7B Uncensored: " -ForegroundColor Red
    Write-Host "4" -ForegroundColor Green
    Write-Host -NoNewline "Koala 7B: " -ForegroundColor Red
    Write-Host "5" -ForegroundColor Green
    Write-Host -NoNewline "Koala 13B: " -ForegroundColor Red
    Write-Host "6" -ForegroundColor Green
    Write-Host -NoNewline "GPT4ALL-J v1.3: " -ForegroundColor Red
    Write-Host "7" -ForegroundColor Green

    $choice = Read-Host "Enter a number"
} while ($choice -notin "1", "2", "3", "4", "5", "6", "7")

if ($choice -eq "1") {
    Get-VincunaCPU13B
    $modelFile = "ggml-vic13b-q5_1.bin"
} elseif ($choice -eq "2") {
    Get-VincunaUncensoredCPU13B
    $modelFile = "ggml-vic13b-uncensored-q4_0.bin"
} elseif ($choice -eq "3") {
    Get-VicunaCPU7B
    $modelFile = "ggml-vic7b-q4_0.bin"
} elseif ($choice -eq "4") {
    Get-VicunaUncensoredCPU7B
    $modelFile = "ggml-vic7b-uncensored-q4_0.bin"
} elseif ($choice -eq "5") {
    Get-KoalaCPU7B
    $modelFile = "koala-7B.ggmlv3.q4_0.bin"
} elseif ($choice -eq "6") {
    Get-KoalaCPU13B
    $modelFile = "koala-13B.ggmlv3.q4_0.bin"
} elseif ($choice -eq "7") {
    Get-Gpt4All
    $modelFile = "koala-13B.ggmlv3.q4_0.bin"
}

# 9. Set up the models in env:
Write-Host "Configuring privateGPT" -ForegroundColor Yellow
$filePath = ".env"
$content = Get-Content $filePath
if ($choice -eq "7") {
    $updatedContent = $content | ForEach-Object {
        if ($_ -match "^MODEL_TYPE=") {
            "MODEL_TYPE=GPT4All"
        } elseif ($_ -match "^MODEL_PATH=") {
            "MODEL_PATH=models/ggml-gpt4all-j-v1.3-groovy.bin"
        } else {
            $_
        }
    }
} else {
    $updatedContent = $content | ForEach-Object {
        if ($_ -match "^MODEL_TYPE=") {
            "MODEL_TYPE=LlamaCpp"
        } elseif ($_ -match "^MODEL_PATH=") {
            "MODEL_PATH=models/$modelFile"
        } else {
            $_
        }
    }
}
Set-Content -Path $filePath -Value $updatedContent

# 10. Create Launcher files
Write-Host "Creating launcher files..." -ForegroundColor Yellow
# - Updater
$OutputFilePath = "update.bat"
$OutputText = "@echo off`ngit pull"
Set-Content -Path $OutputFilePath -Value $OutputText

$ReinstallCommand = ""
if ($condaFound -and ((Get-CimInstance Win32_VideoController).Name -like "*Nvidia*")) {
    $ReinstallCommand += "conda install cudatoolkit -y`n"
}

$ReinstallCommand += "python -m pip install -r requirements.txt`npython -m pip install requests `"urllib3<2`""

if ($condaFound) {
    # As the Windows Target path can only have 260 chars, we easily hit that limit... (Shortcuts) and some users don't know about running ps1 files.
    $condaPath = "`"$(Get-CondaPath)`""
    $CondaEnvironmentName = "pgpt"
    $InstallLocation = "`"$TCHT\privateGPT`""

    # - Ingest
    $ProgramName = "privateGPT Ingest"
    $RunCommand = "python ingest.py"
    $LauncherName = "ingest"
    
    New-LauncherWithErrorHandling -ProgramName $ProgramName -InstallLocation $InstallLocation -RunCommand $RunCommand -ReinstallCommand $ReinstallCommand -CondaPath $condaPath -CondaEnvironmentName $CondaEnvironmentName -LauncherName $LauncherName

    # - Run PrivateGPT
    $ProgramName = "privateGPT"
    $RunCommand = "python privateGPT.py"
    $LauncherName = "run-privategpt"
    
    New-LauncherWithErrorHandling -ProgramName $ProgramName -InstallLocation $InstallLocation -RunCommand $RunCommand -ReinstallCommand $ReinstallCommand -CondaPath $condaPath -CondaEnvironmentName $CondaEnvironmentName -LauncherName $LauncherName

} else {
    $InstallLocation = "`"$TCHT\privateGPT`""

    # - Ingest
    $ProgramName = "privateGPT Ingest"
    $RunCommand = "python ingest.py"
    $LauncherName = "ingest"
    New-LauncherWithErrorHandling -ProgramName $ProgramName -InstallLocation $InstallLocation -RunCommand $RunCommand -ReinstallCommand $ReinstallCommand -LauncherName $LauncherName

    # - Run PrivateGPT
    $ProgramName = "privateGPT"
    $RunCommand = "python privateGPT.py"
    $LauncherName = "run-privategpt"
    New-LauncherWithErrorHandling -ProgramName $ProgramName -InstallLocation $InstallLocation -RunCommand $RunCommand -ReinstallCommand $ReinstallCommand -LauncherName $LauncherName
}

# 11. Create desktop shortcuts?
Clear-ConsoleScreen
Write-Host "Create desktop shortcuts for privateGPT?" -ForegroundColor Cyan
do {
    Write-Host -ForegroundColor Cyan -NoNewline "`n`nDo you want desktop shortcuts? (y/n) [Default: y]: "
    $shortcuts = Read-Host
} while ($shortcuts -notin "Y", "y", "N", "n", "")

if ($shortcuts -in "Y","y", "") {
    Import-RemoteFunction -ScriptUri "https://New-Shortcut.tc.ht" # Import function to create a shortcut
    
    Write-Host "Downloading privateGPT icon (not official)..."
    Invoke-WebRequest -Uri 'https://tc.ht/PowerShell/AI/privateGPT.ico' -OutFile 'privateGPT.ico'

    Write-Host "`nCreating shortcuts on desktop..." -ForegroundColor Cyan
    $shortcutName = "privateGPT"
    $targetPath = "run-privategpt.bat"
    $IconLocation = 'privateGPT.ico'
    New-Shortcut -ShortcutName $shortcutName -TargetPath $targetPath -IconLocation $IconLocation
}

# 12. Launch privateGPT
Clear-ConsoleScreen
Write-Host "Launching privateGPT!`n" -ForegroundColor Cyan
./run-privategpt.bat