Skip to content

README.md

Latest commit

 

History

History
37 lines (26 loc) · 1.9 KB

README.md

File metadata and controls

37 lines (26 loc) · 1.9 KB
Raw

HealthLLM.jl

Stable Dev Build Status Coverage Code Style: Blue

HealthLLM.jl is a Julia package for retrieval-augmented workflows over health-oriented corpora and structured clinical data. It focuses on a small set of building blocks for preparing corpora, building RAG indexes, generating query-oriented answers, and storing embeddings in PostgreSQL with pgvector.

What the project contains

  • Corpus preparation utilities for collecting files and writing combined sources.
  • RAG pipeline helpers built around RAGTools and PromptingTools.
  • Query-generation helpers for retrieval-backed, FunSQL-oriented workflows.
  • PostgreSQL embedding storage utilities targeting pgvector.

Detailed setup, usage, and testing instructions live in the hosted docs: https://juliahealth.github.io/HealthLLM.jl/dev/

Repository layout

  • src/: package source code.
  • docs/: Documenter site and docs-specific environment.
  • test/: test suite and test-specific environment.
  • FunSQLQueries/: query-related assets used by the project.
  • .env.example: example environment variable template.
  • CITATION.bib: citation metadata.

Documentation

Citation

See CITATION.bib for citation details.