Skip to content

Latest commit

 

History

History
84 lines (55 loc) · 3.54 KB

README.md

File metadata and controls

84 lines (55 loc) · 3.54 KB
Raw

LlamaFS

Inspiration

Watch the explainer video

Open your ~/Downloads directory. Or your Desktop. It's probably a mess...

There are only two hard things in Computer Science: cache invalidation and naming things.

What it does

LlamaFS is a self-organizing file manager. It automatically renames and organizes your files based on their contents and well-known conventions (e.g., time). It supports many kinds of file, and even images (through Moondream) and audio (through Whisper).

LlamaFS runs in two "modes" - as a batch job (batch mode), and an interactive daemon (watch mode).

In batch mode, you can send a directory to LlamaFS, and it will return a suggested file structure and organize your files.

In watch mode, LlamaFS starts a daemon that watches your directory. It intercepts all filesystem operations, updates i and uses your most recent edits in context to proactively learn and how, so you don't learns predict how you rename file. e.g. if you create a folder for 2023 tax documents, and start moving 1-3 file in it, LlamaFS will automatically creates, and move the right!

Uhh... Sending all my personal files to an API provider?! No thank you!

It also has a toggle for "incognito mode", allowing you route every request through Ollama instead of Groq. Since they use the same Llama 3 model, the perform identically.

How we built it

We built LlamaFS on a Python backend, leveraging the Llama3 model through Groq for file content summarization and tree structuring. For local processing, we integrated Ollama running the same model to ensure privacy in incognito mode. The frontend is crafted with Electron, providing a sleek, user-friendly interface that allows users to interact with the suggested file structures before finalizing changes.

  • It's extremely fast! (for LLM standards)! Most file ops are processed in <500ms in watch mode (benchmarked by AgentOps). This is because of our smart caching, that selectively rewrites sections of the index based on the minimum nessecary filesystem diff. And of course, Groq's super fast inference API. 😉

  • It's immediately useful - It's very low friction to use, and a problem almost everyone has. We started using it ourselves on this project (very Meta)

What's next for LlamaFS

  • Find and remove old/unused files
  • We have some really cool ideas for - filesystem diffs are hard...

Installation

Prerequisites

Before installing, ensure you have the following requirements:

  • Python 3.10 or higher
  • pip (Python package installer)

Installing

To install the project, follow these steps:

  1. Clone the repository:

    git clone https://github.com/iyaja/llama-fs.git

  2. Navigate to the project directory:

    cd llama-fs

  3. Install requirements

    pip install -r requirements.txt

  4. (Optional) Install moondream if you want to use the incognito mode

    ollama pull moondream

Usage

To serve the application locally using FastAPI, run the command

fastapi dev server.py

This will run the server by default on port 8000. The API can be queried using a curl command, and passing in the file path as the argument. For example, on the Downloads folder

curl -X POST http://127.0.0.1:8000 \
 -H "Content-Type: application/json" \
 -d '{"path": "/Users/<username>/Downloads/", "instruction": "string", "incognito": false}'