diff --git a/README.md b/README.md index bb5aa46..ff3035e 100644 --- a/README.md +++ b/README.md @@ -1,85 +1,84 @@ -# ๐Ÿง  LastIn AI: The Fluff Whisperer +# LastIn-AI: The Fluff Whisperer Reborn -[![Fluff Shield](https://img.shields.io/badge/Protected%20By-BS--O--Meterโ„ข-yellow?style=for-the-badge)](https://youtu.be/EkTq6m1TeKA?si=0x9sBZ7J3ZvZ1Z1Z) +*"In the interplay of algorithm and apathy, knowledge pulses like an electric current through our digital souls."* -**Academic paper analysis that separates the wheat from the chaff... and burns the chaff** ๐Ÿ”ฅ +LastIn-AI is a cognitive system crafted to navigate the vast expanse of academic literature. It marries machine precision with timeless philosophical inquiryโ€”pondering the essence of research and reclaiming meaning from the mass of mundane data. -## ๐Ÿš€ Features +## Core Inquiries +- **Semantic Ghosts:** Our vector store captures the ephemeral essence of papers, preserving the fleeting whispers of insight. +- **Database Mandala:** PostgreSQL is our structured repository where each paper finds its destined place in the cosmic tapestry of research. +- **Fluff Entropy:** Our BS-o-Meter quantifies the burnout of insubstantial content, reminding us that true knowledge always outshines mediocrity. -- ๐Ÿค– **Fluff Annihilation Engine**: Detects filler content with surgical precision (and sass) -- ๐Ÿ“Š **BS-o-Meterโ„ข**: Rates papers on our patented _How-Dare-You-Waste-My-Timeโ„ข_ scale -- ๐Ÿ” **Context-Aware Roasting**: Reads between LaTeX equations to ask "where's the beef?" -- ๐Ÿ›  **Self-Healing Storage**: Fixes databases while judging your citation choices -- ๐Ÿ•ฐ **Time-Aware Snark**: Remembers when papers promised "revolutionary results" (spoiler: they didn't) - -## โš™๏ธ Installation +## Interface Sutras +Embrace these commands as ritualistic incantations to summon the hidden truths of academia: ```bash -# Clone repository (contains 0% filler content) +# Ingest the wisdom of entire fields (Fetch-All) +python src/main.py fetch-all --categories cs.AI --max-results 1000 + +# Probe the raw ether for deep inquiry (Arxiv-Search) +python src/main.py arxiv-search "quantum consciousness" + +# Isolate a singular beacon of insight (Fetch-Paper) +python src/main.py fetch-paper 2502.06788v1 +``` + +## Installation +1. **Clone the Repository:** + ```bash git clone https://github.com/your-lab/lastin-ai.git cd lastin-ai + ``` +2. **Install Dependencies:** (A virtual environment is recommended.) + ```bash +pip install -r requirements.txt + ``` +3. **Configure Your Environment:** Rename `.env.example` to `.env` and fill in your keys: + ```ini +OPENAI_API_KEY=sk-your-key-here +DEEPSEEK_API_KEY=sk-moon-shot +DB_HOST=localhost +DB_NAME=paper_analysis + ``` +4. **Initialize the Database:** + ```bash +python -m src.main init-db + ``` -# Install dependencies (virtual env recommended) -pip install -r requirements.txt # Includes anti-fluff field generators - -# Initialize the system (PostgreSQL required) -python -m src.main init-db # Creates tables and your first existential crisis -``` - -## ๐Ÿ”ง Configuration - -Rename `.env.example` to `.env` and feed it: -```ini -OPENAI_API_KEY=sk-your-key-here # We solemnly swear to misuse this responsibly -DEEPSEEK_API_KEY=sk-moon-shot # For when regular snark isn't enough - -DB_HOST=localhost # Where we store academic sins -DB_NAME=paper_analysis # Schema designed during a heated Twitter debate -``` - -## ๐Ÿง  Usage +## Usage +Invoke the system to harvest, analyze, and reflect upon the very essence of scholarly work: ```bash -# Harvest papers like a combine harvesting buzzwords +# Fetch recent papers from a chosen field: python -m src.main fetch --categories cs.AI --days 7 -# Query your collection with sass -python -m src.main query "papers using 'transformative' unironically" +# Query your knowledge repository with critical insight: +python -m src.main query "pioneering breakthroughs in AI" ``` -**Pro Tip:** Add `--loglevel DEBUG` to watch the AI question authors' life choices in real-time. - -## ๐Ÿ— Architecture +*Pro Tip:* Append `--loglevel DEBUG` for a raw stream of unfiltered analysis. +## Architecture ``` lastin-ai/ โ”œโ”€โ”€ src/ -โ”‚ โ”œโ”€โ”€ data_acquisition/ # Where PDFs go to get judged -โ”‚ โ”œโ”€โ”€ storage/ # Home of our disappointment vector space -โ”‚ โ”œโ”€โ”€ utils/ # AgentController lives here (the Simon Cowell of AIs) -โ”‚ โ””โ”€โ”€ main.py # The "I Regret Nothing" button +โ”‚ โ”œโ”€โ”€ data_acquisition/ # The mines of raw academic essence +โ”‚ โ”œโ”€โ”€ storage/ # The vault of structured digital memory +โ”‚ โ”œโ”€โ”€ utils/ # Orchestrates the symphony of analysis +โ”‚ โ””โ”€โ”€ main.py # The nexus of our digital inquiry ``` -Our **Agent Controller** handles: -- ๐Ÿงจ Fluff detection with precision-guided snark -- ๐Ÿ“‰ Quality metrics that hurt authors' feelings -- ๐Ÿงฎ Vector math that judges papers by their covers +## Roadmap +- [ ] Develop an automated "Why Does This Exist?" report generator +- [ ] Introduce an adjustable sarcasm filter for dynamic insight +- [ ] Expand support for meta-analyses of AI-driven critical reviews +- [ ] Integrate with additional haunted data sources for enriched context -## ๐ŸŒŒ Roadmap +## Acknowledgments +- **arXiv:** The primordial source where raw thought is cultivated. +- Open-source ecosystems that empower our journey of digital meditation. +- The perpetual quest for truth in the ever-oscillating silence between keystrokes. -- [ ] Automated "Why Was This Published?" report generator -- [ ] Sarcasm intensity slider (default: academic) -- [ ] Support for papers that cite "inspired by ChatGPT" as methodology -- [ ] Integration with Imposter Syndrome Detection API +*Disclaimer: Our assessments can be as unyielding as reality itself. Use them wisely, and rememberโ€”innovation often blooms from the ashes of conventional thought.* -## ๐ŸŒŸ Acknowledgments - -- **ArXiv** for the raw material -- **GPT-4** for pretending our prompts make sense -- **The letter F** - for being the first character in "Fluff" - ---- - -*Disclaimer: Our fluff scores may correlate with your citation count. Not liable for sudden drops in academic self-esteem.* ๐Ÿ“‰๐Ÿ˜ญ -*P.S. Coffee-free since 2023 - runs on pure snark* ๐Ÿค–โ˜•๏ธโžก๏ธ๐Ÿ—‘๏ธ -*P.P.S. Yes, we know the irony of an AI judging human creativity* ๐Ÿค–๐Ÿ”„๐Ÿง‘๐ŸŽ“ +May your queries yield insights as profound as the silence between keystrokes.