ix-tools/README.md

3.3 KiB
Raw Permalink Blame History

ix-tools — Inference-X Community Toolchain

Tools, scripts, and source files for the Inference-X ecosystem.

Built in Morocco · Community-maintained · MIT License


Repository Structure

ix-tools/
│
├── site/                      # Frontend source files
│   ├── vitrine/               # inference-x.com (site vitrine)
│   │   └── index.html         # Main site — community portal
│   └── saas/                  # build.inference-x.com
│       ├── index.html         # SaaS frontend (demo + repos + builder)
│       └── demo_module.js     # Free demo backend module
│
├── tools/                     # Developer tools
│   ├── builder/               # IX config builder
│   ├── organ/                 # Organ store API client
│   ├── forge/                 # Model forge (quantize, convert, package)
│   ├── store/                 # Community model store tools
│   └── compilation/           # Cross-platform build scripts
│
├── scripts/                   # Deployment & operations
│   ├── install.sh             # Universal installer
│   ├── deploy-node2.sh        # Deploy to production VPS
│   ├── deploy-node1.sh        # Deploy to build VPS
│   └── monitor.sh             # Health monitoring
│
└── docs/                      # Documentation
    ├── ARCHITECTURE.md        # System architecture
    ├── API.md                 # API reference
    └── CONTRIBUTING.md        # How to contribute

Tools Overview

🔧 Builder

Generates ready-to-run ix-config.json for any hardware combination.
Supports: CPU/CUDA/Metal/Vulkan/ROCm/OpenCL × Linux/macOS/Windows × ARM/x86

🫀 Organ Store

Tools to package, publish, and install IX "organs" — pre-configured AI personas.
Format: organ.json + GGUF model + system prompt + config

⚒ Forge

Model conversion and quantization pipeline:

  • GGUF conversion from HuggingFace SafeTensors
  • Q4/Q5/Q8/F16 quantization
  • Model packaging for the Store

🏪 Store Client

CLI and API client for the IX community model store:

  • Browse, download, install models
  • Publish your own trained/fine-tuned models
  • Rate and review

🔨 Compilation

Cross-platform build scripts for the IX engine:

./tools/compilation/build-linux-x64.sh
./tools/compilation/build-macos-arm64.sh
./tools/compilation/build-windows-x64.sh
./tools/compilation/build-raspberry.sh

Quick Install

# Universal installer
# Download the binary from https://inference-x.com
# Or build from source: git clone https://git.inference-x.com/elmadani/inference-x

# Manual
git clone https://git.inference-x.com/elmadani/ix-tools
cd ix-tools
./scripts/install.sh

Contributing

  1. Fork this repo on git.inference-x.com
  2. Create a branch: git checkout -b feature/my-tool
  3. Submit a PR
  4. A craton administrator reviews

Craton system: The 11 geological cratons each have an administrator who reviews contributions from their region. See 11 Cratons.


License

MIT — Free for all use, commercial and personal.
The IX engine itself uses the SALKA-IX License.


Built by the community — continuing the work of open infrastructure builders.