Skip to content

docs(demo): add seed-full target and update docs for complete DB setup #130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PabloVc-77 merged 1 commit into from
Jul 30, 2026
Merged

docs(demo): add seed-full target and update docs for complete DB setup #130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,12 @@ python scripts/generate_keys.py
# 6. Local database (Postgres + pgvector via Docker)
docker compose up -d

# 7. Seed the 3 demo authors
python scripts/seed_corpus.py
# 7. Seed the 3 demo authors (raw text + embeddings + style profiles)
python scripts/seed_corpus.py --with-embeddings --with-profiles
# ⚠️ This step is slow on first run. It downloads two large ML models:
# • all-mpnet-base-v2 (~420 MB, sentence-transformers)
# • en_core_web_lg (~560 MB, spaCy)
# Omit both flags for a fast seed (raw text only, no profiles/embeddings).
```

Editor extensions (highly recommended — auto-format on save): **Ruff**, **Black Formatter**, **Prettier**, **Python**. See §8.4.
Expand Down
8 changes: 6 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
# Usage: `make help` to list targets.

.DEFAULT_GOAL := help
.PHONY: help install install-py install-front keys db-up db-down seed seed-dry demo \
.PHONY: help install install-py install-front keys db-up db-down seed seed-full seed-dry demo \
dev back front lint format test clean

# ---- Meta -------------------------------------------------------------------
Expand Down Expand Up @@ -58,10 +58,14 @@ db-down: ## Stop the local database
$(call need_file,docker-compose.yml,Sprint 1)
docker compose down

seed: ## Seed the DB with the 3 preloaded authors (Austen, Dickens, Poe)
seed: ## Seed the DB with raw text only — fast, no ML models required
$(call need_file,scripts/seed_corpus.py,Sprint 2)
python scripts/seed_corpus.py

seed-full: ## Seed the DB + compute embeddings and style profiles (downloads ~980 MB of ML models on first run)
$(call need_file,scripts/seed_corpus.py,Sprint 2)
python scripts/seed_corpus.py --with-embeddings --with-profiles

seed-dry: ## Validate corpus files and print manifest without touching the DB
$(call need_file,scripts/seed_corpus.py,Sprint 2)
python scripts/seed_corpus.py --dry-run
Expand Down
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,8 +170,12 @@ make keys
# 5. Start local Postgres + pgvector
make db-up

# 6. Seed the database with the 3 preloaded authors
make seed
# 6. Seed the database: raw text + embeddings + style profiles
make seed-full
# ⚠️ This step is slow on first run. It downloads two large ML models:
# • all-mpnet-base-v2 (~420 MB, sentence-transformers)
# • en_core_web_lg (~560 MB, spaCy)
# If you only need raw text without profiles/embeddings, use `make seed` instead.

# 7. Start backend + frontend (parallel)
make dev
Expand Down
Loading