docs: professional README — Feb 2026
This commit is contained in:
parent
44664bcc5f
commit
beb407e6db
66
README.md
66
README.md
@ -1,44 +1,50 @@
|
|||||||
|
<div align="center">
|
||||||
|
|
||||||
# IX Relay
|
# IX Relay
|
||||||
*Part of the Inference-X Ecosystem*
|
|
||||||
|
|
||||||
[](LICENSE)
|
**Federated inference network — share compute, earn credits**
|
||||||
|
|
||||||
**Federated inference network. Your idle hardware earns you compute credits.**
|
[]()
|
||||||
|
|
||||||
deliver water using only gravity. IX Relay delivers inference using idle community compute.
|
[inference-x.com](https://inference-x.com)
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 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
|
You IX Relay Network
|
||||||
→ IX Relay runs community inference jobs
|
├── Idle GPU? → Serve requests → earn credits
|
||||||
→ You earn compute credits
|
└── Need more? → Send requests → spend credits
|
||||||
→ Use credits when you need heavy inference
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## 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
|
```bash
|
||||||
pip install fastapi uvicorn
|
# Register your node
|
||||||
python ix_relay.py
|
./inference-x --relay --port 8080 --credits-addr your-wallet
|
||||||
# → API at http://localhost:7938
|
|
||||||
|
# Check your earnings
|
||||||
|
./ix-relay status
|
||||||
```
|
```
|
||||||
|
|
||||||
## API
|
## Status
|
||||||
```
|
|
||||||
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
|
|
||||||
```
|
|
||||||
|
|
||||||
## How Credits Work
|
Alpha — protocol designed, reference implementation in progress.
|
||||||
- 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
|
|
||||||
|
|
||||||
## Philosophy
|
---
|
||||||
|
|
||||||
Built in Morocco for the world. 🇲🇦
|
*Part of the [Inference-X community](https://git.inference-x.com/inference-x-community)*
|
||||||
|
|
||||||
## License
|
|
||||||
[Business Source License 1.1](LICENSE)
|
|
||||||
**Author:** Salka Elmadani
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user