docs: professional README — Feb 2026

This commit is contained in:
Inference-X 2026-02-25 17:29:57 +00:00
parent 974eb70d31
commit 99b0b62021

View File

@ -1,42 +1,45 @@
<div align="center">
# IX Scout
*Part of the Inference-X Ecosystem*
[![License: BSL-1.1](https://img.shields.io/badge/License-BSL_1.1-orange.svg)](LICENSE)
**Real-time global map of every Inference-X node**
**Real-time global map of every Inference-X node.**
[![Status](https://img.shields.io/badge/Status-Beta-blue.svg)]()
When you run IX Engine with `--scout`, you optionally report anonymous hardware telemetry.
IX Scout aggregates this data into a live map of the community's collective compute.
[inference-x.com](https://inference-x.com)
</div>
---
## What is IX Scout?
IX Scout is a live global map showing all publicly registered Inference-X nodes — their location, models, hardware, and availability.
## Features
- **Live map** — geographic view of the IX network
- **Anonymous by default** — nodes show region, not exact location
- **Hardware stats** — GPU model, VRAM, performance tier
- **Model availability** — which models each node serves
- **Latency** — estimated response time from your location
## Register your node
## Deploy Scout Server
```bash
pip install fastapi uvicorn
python ix_scout.py
# → API at http://localhost:7936
# Add to your inference-x startup
./inference-x model.gguf --serve 8080 --scout-register
# Or via config
echo "SCOUT_REGISTER=true" >> ~/.inference-x/config
```
## Enable Node Reporting
```bash
# Add --scout flag to your IX Engine command
./inference-x model.gguf --serve 8080 --scout https://scout.inference-x.com
```
Registration is opt-in. No tracking, no telemetry.
## API
```
POST /report — IX Engine nodes report telemetry
GET /stats — Aggregated stats (24h window)
GET /nodes — Recent nodes (anonymized)
GET /health — Service status
```
## Status
## Privacy
- All telemetry is anonymous (no IPs stored)
- Opt-in only via explicit `--scout` flag
- Only hardware specs reported (backend, RAM, speed, country optional)
- Data retained for 24 hours then pruned
Beta — map functional, registration API stable.
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)*