######################
HOOPS AI Documentation
######################

The **HOOPS AI SDK** is a Python framework that enables development teams to quickly and reliably bring **Artificial Intelligence** into the **3D Computer Aided Design** world.
It is designed not only for CAD engineers who want to leverage their data for machine learning, but also for data scientists aiming to solve CAD-specific problems or more. The HOOPS AI framework facilitates machine learning workflows with 3D CAD by providing:

* **Access** to Geometrical & Topological 3D CAD data  
* **Encoding** and management of datasets
* **Control** over data pipelines
* **Training of models** using either pre-built architectures or custom machine learning frameworks

HOOPS AI also allows you to **visualize and analyze** your 3D data within a web-based graphics environment, enabling interactive exploration and deeper insights directly in the browser.


.. container:: linkbox-grid-container

   .. container:: linkbox

      .. rubric:: Getting Started
         :class: title

      .. container:: tagline

            Prerequisites and quickstart walkthrough for new developers

      * :doc:`Technical Overview </getting_started/technical_overview>`
      * :doc:`File Formats </getting_started/file_formats>`
      * :doc:`Supported Platforms </getting_started/supported_platforms>`
      * :doc:`Evaluate & Install </getting_started/evaluate>`

   .. container:: linkbox

      .. rubric:: Tutorials
         :class: title

      .. container:: tagline

            How to build real-world applications

      * :doc:`/tutorials/data_access`
      * :doc:`/tutorials/data_encode`
      * :doc:`/tutorials/data_management`
      * :doc:`/tutorials/fabwave_case`
      * :doc:`/tutorials/data_mining`
      * :doc:`/tutorials/data-mining-tryhard`
      * :doc:`/tutorials/train_model`
      * :doc:`/tutorials/cad_inference`

   .. container:: linkbox

      .. rubric:: Programming Guide
         :class: title

      .. container:: tagline

            Your comprehensive guide to HOOPS AI modules and components

      * :doc:`CAD Fundamentals </programming_guide/cad-fundamentals>`
      * :doc:`Machine Learning Fundamentals </programming_guide/ml-fundamentals>`
      * :doc:`Data Flow Management </programming_guide/data-flow-management>`
         * :doc:`CAD Data Access </programming_guide/cad-data-access>`
         * :doc:`CAD Data Encoding </programming_guide/cad-data-encoding>`
         * :doc:`Datasets: ML-Ready Input </programming_guide/datasets>`
         * :doc:`Data Storage </programming_guide/storage>`
         * :doc:`Data Flow Customization </programming_guide/flow>`
      * :doc:`Machine Learning Models </programming_guide/ml-model>`
         * :doc:`Dataset Exploration and Mining </programming_guide/explore-dataset>` 
         * :doc:`Parts Classification Model </programming_guide/part-class>`
         * :doc:`CAD Feature Recognition Model </programming_guide/feature-rec>`
         * :doc:`Develop your own ML model </programming_guide/train>`      
      * :doc:`/programming_guide/cad-data-visualization`

   .. container:: linkbox

      .. rubric:: Python API Reference
         :class: title

      .. container:: tagline

            Comprehensive reference for the Python API   

      * :doc:`HOOPS AI module <api_ref/hoops_ai>`
      
   .. container:: linkbox

      .. rubric:: Additional Resources
         :class: title

      .. container:: tagline

            Stay up to date with the latest changes and improvements

      * :doc:`Release Notes </resources/release_notes/index>`
      * :doc:`Public Roadmap </resources/public_roadmap>`
      * :doc:`Acknowledgments </resources/Acknowledgments>`
      * :doc:`Distributing Your Application </resources/distribute_application>`
      * :doc:`Downloads </resources/downloads>`
      * :doc:`Glossary </resources/glossary>`
      * :doc:`Archives </resources/archives>`


   .. container:: linkbox

      .. rubric:: Support
         :class: title

      .. container:: tagline

            Get help and resolve common issues

      * :doc:`Forum </support/forum>`
      * :doc:`Developer Support </support/support_portal>`
      * :doc:`Knowledge Base </support/knowledge_base>`
      * :doc:`Contact Us </support/contact_us>`
   
   
.. toctree::
   :maxdepth: 1
   :caption: Getting Started
   :titlesonly:
   :hidden:
   
   /getting_started/technical_overview
   /getting_started/file_formats
   /getting_started/supported_platforms
   /getting_started/evaluate
   
   
.. toctree::
   :caption: Programming Guide
   :maxdepth: 2
   :hidden:
   
   /programming_guide/cad-fundamentals
   /programming_guide/ml-fundamentals

.. toctree::
   :maxdepth: 1
   :hidden:
   :titlesonly:

   /programming_guide/data-flow-management
   /programming_guide/ml-model
   /programming_guide/cad-data-visualization


   
.. toctree::
   :maxdepth: 1
   :caption: Python API Reference
   :titlesonly:
   :hidden:

   hoops_ai module <api_ref/hoops_ai>

.. toctree::
   :maxdepth: 1
   :caption: Tutorials
   :titlesonly:
   :hidden:

   /tutorials/data_access
   /tutorials/data_encode
   /tutorials/data_management
   /tutorials/fabwave_case
   /tutorials/data_mining
   /tutorials/data-mining-tryhard
   /tutorials/train_model
   /tutorials/cad_inference

.. toctree::
   :maxdepth: 1
   :caption: Additional Resources
   :titlesonly:
   :hidden:

   /resources/release_notes/index
   /resources/public_roadmap
   /resources/Acknowledgments
   /resources/distribute_application
   /resources/downloads
   /resources/glossary
   /resources/archives


.. toctree::
   :maxdepth: 1
   :caption: Support
   :titlesonly:
   :hidden:
   
   /support/forum
   /support/knowledge_base
   /support/support_portal
   /support/contact_us
   

.. This is a comment