Readme file update
This commit is contained in:
parent
d5b90f555d
commit
16eb77784e
74
README.md
74
README.md
@ -1,83 +1,85 @@
|
|||||||
# 🧠 LastIn AI: Your Paper's New Overlord
|
# 🧠 LastIn AI: The Fluff Whisperer
|
||||||
|
|
||||||
[](https://www.youtube.com/watch?v=dQw4w9WgXcQ)
|
[](https://youtu.be/EkTq6m1TeKA?si=0x9sBZ7J3ZvZ1Z1Z)
|
||||||
|
|
||||||
**An AI system that reads, judges, and organizes papers so you can pretend you're keeping up with the literature**
|
**Academic paper analysis that separates the wheat from the chaff... and burns the chaff** 🔥
|
||||||
|
|
||||||
## 🚀 Features
|
## 🚀 Features
|
||||||
|
|
||||||
- 🤖 **Self-Optimizing Pipeline**: Now with 20% more existential dread about its purpose
|
- 🤖 **Fluff Annihilation Engine**: Detects filler content with surgical precision (and sass)
|
||||||
- 🧩 **Modular Architecture**: Swappable components like you're building Ikea furniture for robots
|
- 📊 **BS-o-Meter™**: Rates papers on our patented _How-Dare-You-Waste-My-Time™_ scale
|
||||||
- 🔍 **Context-Aware Analysis**: Reads between LaTeX equations like a PhD student reads Twitter
|
- 🔍 **Context-Aware Roasting**: Reads between LaTeX equations to ask "where's the beef?"
|
||||||
- 🛠 **Self-Healing Storage**: Fixes database issues while questioning why it bothers
|
- 🛠 **Self-Healing Storage**: Fixes databases while judging your citation choices
|
||||||
- 🤯 **Flux Capacitor Mode**: Time-aware processing (results may violate causality)
|
- 🕰 **Time-Aware Snark**: Remembers when papers promised "revolutionary results" (spoiler: they didn't)
|
||||||
|
|
||||||
## ⚙️ Installation
|
## ⚙️ Installation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Clone repository (we promise there's no paperclip maximizer)
|
# Clone repository (contains 0% filler content)
|
||||||
git clone https://github.com/your-lab/lastin-ai.git
|
git clone https://github.com/your-lab/lastin-ai.git
|
||||||
cd lastin-ai
|
cd lastin-ai
|
||||||
|
|
||||||
# Install dependencies (virtual env recommended)
|
# Install dependencies (virtual env recommended)
|
||||||
pip install -r requirements.txt # Now with non-Euclidean dependency resolution!
|
pip install -r requirements.txt # Includes anti-fluff field generators
|
||||||
|
|
||||||
# Initialize the system (requires PostgreSQL)
|
# Initialize the system (PostgreSQL required)
|
||||||
python -m src.main init-db # Creates tables and a small existential crisis
|
python -m src.main init-db # Creates tables and your first existential crisis
|
||||||
```
|
```
|
||||||
|
|
||||||
## 🔧 Configuration
|
## 🔧 Configuration
|
||||||
|
|
||||||
Rename `.env.example` to `.env` and feed it your secrets:
|
Rename `.env.example` to `.env` and feed it:
|
||||||
```ini
|
```ini
|
||||||
OPENAI_API_KEY=sk-your-key-here # We pinky-promise not to become self-aware
|
OPENAI_API_KEY=sk-your-key-here # We solemnly swear to misuse this responsibly
|
||||||
DEEPSEEK_API_KEY=sk-moon-shot # For when regular AI isn't dramatic enough
|
DEEPSEEK_API_KEY=sk-moon-shot # For when regular snark isn't enough
|
||||||
|
|
||||||
DB_HOST=localhost # Where we store your academic sins
|
DB_HOST=localhost # Where we store academic sins
|
||||||
DB_NAME=paper_analysis # Schema designed during a SIGBOVIK break
|
DB_NAME=paper_analysis # Schema designed during a heated Twitter debate
|
||||||
```
|
```
|
||||||
|
|
||||||
## 🧠 Usage
|
## 🧠 Usage
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Harvest papers like an academic combine
|
# Harvest papers like a combine harvesting buzzwords
|
||||||
python -m src.main fetch --categories cs.AI --days 7
|
python -m src.main fetch --categories cs.AI --days 7
|
||||||
|
|
||||||
# Query your digital hoard
|
# Query your collection with sass
|
||||||
python -m src.main query "papers that cite GPT but clearly didn't read it"
|
python -m src.main query "papers using 'transformative' unironically"
|
||||||
```
|
```
|
||||||
|
|
||||||
**Pro Mode:** Add `--loglevel DEBUG` to watch neural networks question the meaning of "breakthrough".
|
**Pro Tip:** Add `--loglevel DEBUG` to watch the AI question authors' life choices in real-time.
|
||||||
|
|
||||||
## 🏗 Architecture
|
## 🏗 Architecture
|
||||||
|
|
||||||
```
|
```
|
||||||
lastin-ai/
|
lastin-ai/
|
||||||
├── src/
|
├── src/
|
||||||
│ ├── data_acquisition/ # Papers go in, embeddings come out
|
│ ├── data_acquisition/ # Where PDFs go to get judged
|
||||||
│ ├── storage/ # Where vectors go to rethink their life choices
|
│ ├── storage/ # Home of our disappointment vector space
|
||||||
│ ├── utils/ # Home of AgentController (the real protagonist)
|
│ ├── utils/ # AgentController lives here (the Simon Cowell of AIs)
|
||||||
│ └── main.py # The big red button (do not push)
|
│ └── main.py # The "I Regret Nothing" button
|
||||||
```
|
```
|
||||||
|
|
||||||
Our **Agent Controller** handles:
|
Our **Agent Controller** handles:
|
||||||
- 🧬 Data consistency through sheer willpower
|
- 🧨 Fluff detection with precision-guided snark
|
||||||
- 📉 Quality metrics that judge us all
|
- 📉 Quality metrics that hurt authors' feelings
|
||||||
- 🧮 Vector math that would make Von Neumann blush
|
- 🧮 Vector math that judges papers by their covers
|
||||||
|
|
||||||
## 🌌 Roadmap
|
## 🌌 Roadmap
|
||||||
|
|
||||||
- [ ] Implement ethical constraints (optional)
|
- [ ] Automated "Why Was This Published?" report generator
|
||||||
- [ ] Add support for papers written by AIs about AIs
|
- [ ] Sarcasm intensity slider (default: academic)
|
||||||
- [ ] Quantum-resistant pretension detection
|
- [ ] Support for papers that cite "inspired by ChatGPT" as methodology
|
||||||
- [ ] Automated rebuttal generator for peer review
|
- [ ] Integration with Imposter Syndrome Detection API
|
||||||
|
|
||||||
## 🌟 Acknowledgments
|
## 🌟 Acknowledgments
|
||||||
|
|
||||||
- **ArXiv** for the digital paper avalanche
|
- **ArXiv** for the raw material
|
||||||
- **GPUs** for pretending we're not just matrix multiplying
|
- **GPT-4** for pretending our prompts make sense
|
||||||
- **The concept of attention** - you're the real MVP
|
- **The letter F** - for being the first character in "Fluff"
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
*Disclaimer: May occasionally generate paper summaries more coherent than the originals. Not liable for recursive self-improvement loops.* 🤖➰
|
*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* 🤖🔄🧑🎓
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user