AlignAIR Documentation

Install, use, and understand AlignAIR. Pick a section below or start with the quickstart.

// quickstart

New to AlignAIR?

Up and running in under ten minutes. No complex setup required.

Quick install View examples

$ install

docker pull thomask90/alignair:latest
docker run -it --rm \
  -v ~/data:/data \
  thomask90/alignair:latest

01 / install

Installation

Get AlignAIR running with Docker or build from source. System requirements and troubleshooting.

Open

02 / usage

Usage Guide

Run AlignAIR with different parameters, configure thresholds, and optimize for your datasets.

Open

03 / examples

Examples

Real-world examples with sample data, commands, and expected outputs.

Open

04 / technical

Technical Details

Algorithms, neural network architecture, training pipeline, and theoretical background.

Open

05 / reference

API Reference

Complete parameter reference, input/output formats, and integration guides.

Open

06 / help

FAQ & Help

Common questions, troubleshooting guides, and community support.

Open

07 / legal

Terms & License

Legal information, licensing terms, and usage rights.

Open

// popular

Popular pages

Docker Quick Start

Get AlignAIR running in minutes.

Parameter Guide

Configure thresholds for your data.

Model Architecture

Neural network design and training.

// community

Get help and contribute

Join the AlignAIR community on GitHub. Open an issue, start a discussion, or send a pull request.

GitHub Discussions Report an issue

Terms·License·Open Source