API Reference

This section is look-up documentation. Use it when you already know the task and need exact command names, YAML fields, registry strings, or Python signatures. If you are still forming an intuition for the package, return to Quickstart and Guides first.

The curated pages cover the command line interface, the configuration schema, the classifier registry with maturity tiers, and the classifier optimization package. The autosummary tree under API modules is generated from the source and links into viewcode pages when you need to read implementation details.

• CLI reference
  • arcade run
  • arcade list
  • arcade describe
  • arcade validate
  • arcade template
  • arcade explore
  • Related Python API
• Config schema
  • Top-level sections
  • data highlights
  • classifiers
  • sweep, hardware, and visualization
  • Validate and run
• Classifiers reference
  • Support and maturity levels
  • Reference eight-method benchmark
  • Method detail: how each reference method moves through the pipeline
  • Paper and extended recipes
  • Classical extras on filter features
  • Experimental and special names
  • Feature kinds at a glance
  • Pitfalls checklist
  • Extend
• Classifier optimization
  • Public surface
  • Config models
  • Example
• API modules
  • arcade
  • arcade.api
  • arcade.classifiers
  • arcade.classifieroptimization
  • arcade.config
  • arcade.data
  • arcade.features
  • arcade.hardware
  • arcade.qec
  • arcade.stages
  • arcade.runner