Skip to content

Commit

Permalink
doc: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@saghul
saghul committed May 17, 2024
1 parent 644c2ba commit cc8ac0b
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
9 changes: 3 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,15 @@ It is comprised of specialized modules which can be enabled or disabled as neede
# Download the preferred GGUF llama model
mkdir "$HOME/models"

wget -q --show-progress "https://huggingface.co/FaradayDotDev/llama-3-8b-Instruct-GGUF/resolve/main/llama-3-8b-Instruct.Q4_K_M.gguf?download=true" -O "$HOME/models/llama-3-8b-Instruct.Q4_K_M.gguf"
wget -q --show-progress "https://huggingface.co/jitsi/Llama-3-8B-Instruct-GGUF/resolve/main/llama-3-8b-instruct-Q4_K_M.gguf?download=true" -O "$HOME/models/llama-3-8b-instruct.Q4_K_M.gguf"

export LLAMA_PATH="$HOME/models/llama-3-8b-Instruct.Q4_K_M.gguf"
export LLAMA_N_CTX=8192
# Optional for llama-3 since it's auto-detected:
export MODEL_CHAT_FORMAT=llama-3
export LLAMA_PATH="$HOME/models/llama-3-8b-instruct.Q4_K_M.gguf"

# start Redis
docker run -d --rm -p 6379:6379 redis

# disable authorization (for testing)
export BYPASS_AUTHORIZATION="true"
export BYPASS_AUTHORIZATION=1

poetry install
./run.sh
Expand Down
7 changes: 4 additions & 3 deletions docs/summaries_module.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,10 @@ All of the configuration is done via env vars. Check the [Skynet Environment Var
# Download the preferred GGUF llama model
mkdir "$HOME/models"

wget -q --show-progress "https://huggingface.co/FaradayDotDev/llama-3-8b-Instruct-GGUF/resolve/main/llama-3-8b-Instruct.Q4_K_M.gguf?download=true" -O "$HOME/models/llama-3-8b-Instruct.Q4_K_M.gguf"
wget -q --show-progress "https://huggingface.co/jitsi/Llama-3-8B-Instruct-GGUF/resolve/main/llama-3-8b-instruct-Q4_K_M.gguf?download=true" -O "$HOME/models/llama-3-8b-instruct.Q4_K_M.gguf"

export LLAMA_PATH="$HOME/models/llama-3-8b-Instruct.Q4_K_M.gguf"
export LLAMA_PATH="$HOME/models/llama-3-8b-instruct.Q4_K_M.gguf"
# Optional for llama-3 since it's the default:
export LLAMA_N_CTX=8192
# Optional for llama-3 since it's auto-detected:
export MODEL_CHAT_FORMAT=llama-3
Expand All @@ -36,7 +37,7 @@ export MODEL_CHAT_FORMAT=llama-3
docker run -d --rm -p 6379:6379 redis

# disable authorization (for testing)
export BYPASS_AUTHORIZATION="true"
export BYPASS_AUTHORIZATION=1

poetry install
./run.sh
Expand Down

0 comments on commit cc8ac0b

Please sign in to comment.