Skip to content

Byski/Byski-AI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Arqon

Local-first AI study assistant for Irish law — built for FE-1 exam preparation, starting with Constitutional Law. Runs entirely on-device with no paid API required.


Features

  • Chat study mode with inline citations
  • Case brief generator
  • Exam skeleton generator — Issue · Rule · Structure · Counterarguments · Conclusion
  • Quiz mode
  • Document ingestion — upload PDFs, HTML, plain text, Markdown
  • Instant paste analysis — interrogate any passage on the fly
  • Sources panel — every response backed by traceable context
  • Refusal on missing context — no hallucinated legal claims

Why it works better than generic chat for Irish law

Citation-first retrieval means every answer is anchored to your source documents. If the context is absent, the model refuses rather than guesses — critical for exam-grade accuracy.


Stack

Layer Tools
LLM Ollama (local, no API cost)
Vector DB Chroma
Embeddings SentenceTransformers
Backend FastAPI
UI Streamlit

Requirements

  • Python 3.12 or 3.13 (3.14 not yet supported by this stack)
  • Ollama installed locally

Setup

pyenv install 3.12 && pyenv local 3.12   # if needed

python3 -m venv .venv
source .venv/bin/activate
pip install --upgrade pip setuptools wheel
pip install -r requirements.txt
cp .env.example .env

Ollama

ollama pull llama3.1:latest
ollama serve

Run

Terminal 1 — backend

source .venv/bin/activate
uvicorn app.server:app --reload --port 8000

Terminal 2 — UI

source .venv/bin/activate
streamlit run ui/streamlit_app.py
# http://localhost:8501

Add Law Sources

Place files in data/raw/ (.html · .pdf · .txt · .md) and ingest from the UI.

Recommended naming convention:

case__Ryan_v_AG__1965__courts_ie.html
statute__Bunreacht__1937__irishstatutebook.html

Minimum viable corpus for Constitutional Law:

  • Bunreacht na hÉireann full text
  • 15–30 landmark constitutional cases

For a pre-populated deployment, place curated files in data/raw/starter_pack/ and ingest before publishing — users get instant answers on first load.


Scope

Strongest on FE-1 Constitutional Law. Extendable to Contract, Criminal, Equity, and other FE-1 papers by adding the relevant source documents.


Disclaimer: Educational tool only — not legal advice. Verify all claims against official sources.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages