#####################
API Reference
#####################

Welcome to the HOOPS AI API Reference documentation. This section provides comprehensive technical details for all modules, classes, functions, and methods in the HOOPS AI library.

Overview
========

The HOOPS AI API is organized into several core modules:

- **hoops_ai.cadaccess**: Load and query CAD geometry (B-rep faces, edges, meshes, topology)
- **hoops_ai.cadencoder**: Encode CAD data into machine learning features (graph structures, UV grids, attributes)
- **hoops_ai.dataset**: Manage and explore CAD datasets for ML training
- **hoops_ai.flowmanager**: Build automated workflows and task pipelines
- **hoops_ai.ml**: Machine learning models and utilities for CAD analysis
- **hoops_ai.storage**: Data persistence backends (Zarr, memory storage)
- **hoops_ai.insight**: 3D web visualization for CAD models

How to Use This Reference
==========================

Each module page includes:

- **Module Overview**: Purpose and key concepts
- **Classes**: Detailed class documentation with constructor parameters, attributes, and methods
- **Functions**: Standalone functions with parameters, return types, and examples
- **Examples**: Code snippets demonstrating common usage patterns

.. tip::
   **New to HOOPS AI?** Start with the :doc:`/getting_started/index` guide and :doc:`/programming_guide/index` for tutorials and conceptual explanations. Use this API reference when you need detailed technical specifications.

.. seealso::
   - :doc:`/programming_guide/index` - In-depth guides with examples and best practices
   - :doc:`/tutorials/index` - Step-by-step tutorials for common tasks
   - :doc:`/resources/glossary` - Definitions of CAD and ML terminology

Complete API Documentation
===========================

.. .. autosummary::
..    :toctree: api_ref
..    :recursive:

..    hoops_ai