Skip to main content

FinREST & Finola SLM Engine

Python 3.9+ FastAPI Ollama License: MIT

FinREST is an offline-first financial safety and compliance runtime powered by quantized Small Language Models (SLMs) and deterministic arithmetic bounds.

It is engineered specifically to protect international university students under Subclass 500 visa conditions (Condition 8104/8105 work hour caps) while providing real-time liquidity analysis and automated system issue triage via its embedded support intelligence, Finola.


🏛️ Architecture & System Topology

FinREST decouples fuzzy language reasoning from deterministic financial rules to eliminate LLM arithmetic hallucinations while retaining natural interaction.

┌────────────────────────────────────────────────────────────────────────┐ │ Client Consumers │ │ [ BudgetWise AI Desktop (PyQt5) ] │ [ Web Dashboard (JS SDK) ] │ └────────────────────────────────────┬───────────────────────────────────┘ │ pip install finrest (REST / JSON) ▼ ┌────────────────────────────────────────────────────────────────────────┐ │ FinREST Gateway (FastAPI) │ ├────────────────────────────────────────────────────────────────────────┤ │ 1. Deterministic Financial & Policy Calculus Engine │ │ • Labor shift conversion: Hours = Price / Award_Wage │ │ • Visa Condition 8104/8105 Compliance: (Hours + Worked) <= 48h/fn │ │ • Emergency Vault Threshold Validation: (Bal - Price) >= Vault │ │ • Daily SafeSpend Velocity: Rem_Bal / Remaining_Cycle_Days │ │ │ │ 2. Asynchronous Diagnostic & Triage Worker │ │ • Classifies OCR, DB, and UI anomalies │ │ • Background dispatch via SMTP to Administrator │ └────────────────────────────────────┬───────────────────────────────────┘ │ Pre-conditioned JSON Payload ▼ ┌────────────────────────────────────────────────────────────────────────┐ │ Local Inference Layer (Ollama) │ │ Model: Llama 3.2 (3B / 1B) │ │ • Formulates contextual responses within strict math bounds │ │ • Deterministic temperature (0.10) with JSON schema enforcement │ └────────────────────────────────────────────────────────────────────────┘


⚙️ Core Engineering Principles

1. Deterministic Math Prior to Model Inference

LLMs are notoriously prone to floating-point and arithmetic hallucinations. FinREST never asks the language model to perform division, balance subtractions, or visa limit calculations. All financial math is evaluated in pure Python prior to model invocation and passed as verified facts into the prompt context.

2. Regulatory Compliance Enforcement (Subclass 500 Visa)

Australian student visas restrict secondary employment to 48 hours per fortnight during study terms. If an affordability query requires labor shifts that exceed the student's remaining allowable fortnightly hours, the engine flags a VISA_HOURS_RISK verdict regardless of whether the user has sufficient immediate cash.

3. Automated Error Interception & Admin Triage

Finola simultaneously scans input text for runtime errors (e.g., OCR bill-parsing crashes, UI freezes). When detected, the request completes without delay while an asynchronous background task (BackgroundTasks) forwards a structured incident report to engineering support.


🚀 Installation & Setup

Prerequisites

  • Python 3.9+
  • Ollama running locally with Llama 3.2:
    ollama run llama3.2
    

Metadata

Release files for finrest 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for finrest 0.1.1
File Size Uploaded
finrest-0.1.1.tar.gz 4.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for finrest 0.1.1
File Interpreter ABI Platform
finrest-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 8.6 kB

Release files / finrest-0.1.1.tar.gz

Download URL finrest-0.1.1.tar.gz
Size 4.1 kB
Tags Source
SHA-256 checksum
How to use checksums
75eabac7e8e0b89e39ba80e63cf6039916341bc84d2d5d37f12f9aaeaac44f7f
BLAKE2b-256 checksum
How to use checksums
1aa40a578435bfd26753e0aade6ac98d32d9cd54205c874221e01c45aa0db0f1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.3

Release files / finrest-0.1.1-py3-none-any.whl

Download URL finrest-0.1.1-py3-none-any.whl
Size 4.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0db1f7b63fbb9580337cb6c9a81726fe8ebac33cb8d1c6472ab8adca55276111
BLAKE2b-256 checksum
How to use checksums
e4f7294a3dff62526094ae8ef310aecb701912f4742cb1c08a567005cb056c64
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.3

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page