mirror of
https://github.com/vectorize-io/hindsight.git
synced 2026-09-14 19:31:49 +08:00
Ish Fuseini
ba365c723b
* fix(compose): use HINDSIGHT_API_LLM_API_KEY env var * docs(compose): point run examples at HINDSIGHT_API_LLM_API_KEY The compose files no longer read OPENAI_API_KEY, so every doc telling users to export it was left describing a variable nothing reads. - custom-models/README.md + compose header: export the correct var - timescale/README.md quick start, prereq and env-var table - timescale/.env.example: compose's project directory is the compose file's own directory, so this file IS auto-loaded - naming the wrong var here silently dropped the key on the documented happy path --------- Co-authored-by: Ish Fuseini <me@ishfuesini.com> Co-authored-by: Nicolò Boschi <boschi1997@gmail.com>
46 lines
1.7 KiB
YAML
46 lines
1.7 KiB
YAML
name: hindsight-custom-models
|
|
# Example: run a custom Hindsight image with non-default local models baked
|
|
# in at build time, so pod startup does not depend on HuggingFace at runtime.
|
|
#
|
|
# Quick start:
|
|
# export HINDSIGHT_API_LLM_API_KEY=sk-xxx
|
|
# docker compose -f docker/docker-compose/custom-models/docker-compose.yaml up --build
|
|
#
|
|
# Required environment variables:
|
|
# - HINDSIGHT_API_LLM_API_KEY (pair it with HINDSIGHT_API_LLM_PROVIDER to use
|
|
# a provider other than the default openai)
|
|
|
|
services:
|
|
hindsight:
|
|
build:
|
|
context: .
|
|
dockerfile: Dockerfile
|
|
# Override at build time to bake different models:
|
|
# docker compose build --build-arg EMBEDDER=your-org/your-embedder
|
|
args:
|
|
EMBEDDER: sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2
|
|
RERANKER: cross-encoder/mmarco-mMiniLMv2-L12-H384-v1
|
|
container_name: hindsight-custom-models
|
|
ports:
|
|
- "8888:8888"
|
|
- "9999:9999"
|
|
environment:
|
|
HINDSIGHT_API_LLM_PROVIDER: ${HINDSIGHT_API_LLM_PROVIDER:-openai}
|
|
HINDSIGHT_API_LLM_API_KEY: ${HINDSIGHT_API_LLM_API_KEY:-}
|
|
|
|
# Point Hindsight at the models baked into the image above.
|
|
HINDSIGHT_API_EMBEDDINGS_PROVIDER: local
|
|
HINDSIGHT_API_EMBEDDINGS_LOCAL_MODEL: sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2
|
|
HINDSIGHT_API_RERANKER_PROVIDER: local
|
|
HINDSIGHT_API_RERANKER_LOCAL_MODEL: cross-encoder/mmarco-mMiniLMv2-L12-H384-v1
|
|
|
|
# Fail fast if a model is missing from the image instead of silently
|
|
# falling back to a HuggingFace download at runtime.
|
|
HF_HUB_OFFLINE: "1"
|
|
TRANSFORMERS_OFFLINE: "1"
|
|
volumes:
|
|
- pg_data:/home/hindsight/.pg0
|
|
|
|
volumes:
|
|
pg_data:
|