diff --git a/README.md b/README.md index faf3917..e1b142a 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,50 @@ +
+ # IX Relay -*Part of the Inference-X Ecosystem* -[![License: BSL-1.1](https://img.shields.io/badge/License-BSL_1.1-orange.svg)](LICENSE) +**Federated inference network — share compute, earn credits** -**Federated inference network. Your idle hardware earns you compute credits.** +[![Status](https://img.shields.io/badge/Status-Alpha-orange.svg)]() -deliver water using only gravity. IX Relay delivers inference using idle community compute. +[inference-x.com](https://inference-x.com) + +
+ +--- + +## What is IX Relay? + +IX Relay is a federated network where idle Inference-X nodes can serve inference requests from the community. Contribute compute when your hardware is idle; consume credits when you need more. + +## How it works ``` -Your GPU sits idle at night - → IX Relay runs community inference jobs - → You earn compute credits - → Use credits when you need heavy inference +You IX Relay Network +├── Idle GPU? → Serve requests → earn credits +└── Need more? → Send requests → spend credits ``` -## Deploy +## Privacy model + +- **Requests are end-to-end encrypted** between client and serving node +- No central server sees your prompts +- Node operators only see encrypted blobs +- You choose which models your node serves + +## Quick setup + ```bash -pip install fastapi uvicorn -python ix_relay.py -# → API at http://localhost:7938 +# Register your node +./inference-x --relay --port 8080 --credits-addr your-wallet + +# Check your earnings +./ix-relay status ``` -## API -``` -POST /register-node — Register your IX instance as a node -GET /nodes — List active relay nodes -POST /create-account — Create account (10 free credits) -GET /credits/{id} — Check credit balance -GET /health — Service status -``` +## Status -## How Credits Work -- Each inference job costs 0.1–1.0 credits depending on model size -- Each inference job completed earns the node 0.1–1.0 credits -- New accounts start with 10 free credits +Alpha — protocol designed, reference implementation in progress. -## Philosophy +--- -Built in Morocco for the world. 🇲🇦 - -## License -[Business Source License 1.1](LICENSE) -**Author:** Salka Elmadani +*Part of the [Inference-X community](https://git.inference-x.com/inference-x-community)*