Welcome to Qualia’s documentation!

Version:

2.4.1.dev5+g524735a

Qualia is an end-to-end framework for training, quantizing, and deploying deep neural networks on embedded devices.

Getting Started

• Getting Started with Qualia
  • Introduction
  • Prerequisites
  • Installation Options
  • Tutorial: Your First Qualia Project
• Installing Qualia
  • Introduction
  • Before You Begin
  • User Setup
  • Developer Setup
  • Docker Setup
  • Optional Dependencies
  • Qualia components
  • Common Issues and Solutions
• Qualia Docker Environment
  • Introduction
  • Prerequisites
  • Installation Steps
  • Using the Container
  • Troubleshooting

Package Management

• Complete Guide to PDM (Python Development Master)
  • 1. Introduction to PDM
  • 2. Installation
  • 3. Project Management
  • 4. Dependency Management
  • 5. Virtual Environment Handling
  • 6. Publishing Packages
  • 7. Best Practices
  • 8. Advanced Features
  • Common Commands Reference
  • Troubleshooting
• Comprehensive Guide to UV, Venv, and Pip in Python
  • 1. Introduction to Package Management Tools
  • 2. UV Installation
  • 3. Virtual Environment Management
  • 4. Package Installation and Management
  • 5. Best Practices
  • 6. Comparison with Traditional Tools
  • Troubleshooting
  • Advanced Usage
• Update
  • User Setup
  • Developer Setup

User Guide

• Using Qualia
  • Overview
  • Quick Start
  • Workflow Steps
  • Configuration Parameters
  • Best Practices
  • Common Issues
  • Getting Help
• Qualia Configuration Guide
  • Overview
  • Basic Structure
  • Required Sections
  • Optional Sections
  • Best Practices
• Qualia components
  • Dependency graph
  • Qualia
  • Qualia-Core
  • Qualia-Plugin-SNN
  • Qualia-Plugin-SPLEAT
  • Qualia-Plugin-SOM
  • Qualia-Plugin-Template
  • Qualia-CodeGen-Core
  • Qualia-CodeGen-Plugin-SNN
  • Qualia-CodeGen-Plugin-SPLEAT
  • Qualia-CodeGen-Plugin-SOM
• Migration from previous versions
  • Migration from 1.0 (known as MicroAI)

Developer Guide

• Repository structure
  • conf/
  • docs/
  • src/
  • tests/
  • third_party/
  • .editorconfig
  • .gitignore
  • .gitlab-ci.yml
  • .gitmodules
  • CMakeLists.txt
  • LICENSE
  • README.md
  • pyproject.toml
• Python Package Structure
  • Basic Structure
  • Directory Descriptions
  • Notes
• Qualia Plugins Guide
  • Introduction
  • Plugin Structure
  • Using Plugins
  • Creating a Plugin
  • Plugin Categories
  • Best Practices
  • Common Issues and Solutions
  • Example Configurations
• Adding New Datasets to Qualia
  • Base Structure
  • Core Data Structures
  • Expected Data Dimensions
  • Configuration and Parameters
  • Final Steps
• Writing documentation
  • API documentation
  • High-level documentation
  • Build the documentation
  • CI/CD
• Code style and linter
  • Code style
  • Linter
• Type checking
  • Caveats
  • Type checking in Qualia
  • Run mypy
  • Run pyright
  • IDE Integration
  • CI/CD
  • References
• Tests
  • Run tests

Project Information

• Changelog
  • 2.4.0 (24/01/2025)
  • 2.3.0 (15/07/2024)
  • 2.2.0 (01/03/2024)
  • 2.1.0 (16/01/2024)
  • 2.0.0 (24/11/2023)
  • 1.0.0 (15/09/2021)

Indices and tables

• Index

• Module Index

• Search Page