###################
Supported Platforms
###################


Environments
=============

+-------------------------------------+-----------------------------+----------------------------+---------------------------------------------+
| Platform          (Minimum version) | Architecture [#arm64]_      | Runtime Environment        | Build Requirements                          |
+=====================================+=============================+============================+=============================================+
| Microsoft Windows 10                | x86_64                      | :ref:`v142 <pt_msvc>`      | | :ref:`Visual Studio 2019 <pt_msvc>`       |
|                                     |                             |                            | | Minimum SDK version: v10.0.18362.0        |
+-------------------------------------+-----------------------------+----------------------------+---------------------------------------------+
| Linux                               | coming soon...              | coming soon...             | coming soon...                              |
|                                     |                             |                            |                                             |
+-------------------------------------+-----------------------------+----------------------------+---------------------------------------------+
| macOS                               | coming soon...              | coming soon...             | coming soon...                              |
|                                     |                             |                            |                                             |
+-------------------------------------+-----------------------------+----------------------------+---------------------------------------------+

Prerequisites
=============

+-------------------------------------+-----------------------------+
| Technology                          | (Minimum version)           |
+=====================================+=============================+
| Miniconda x86_64                    | Latest                      |                            
|                                     |                             |                           
+-------------------------------------+-----------------------------+
| CUDA for GPU support                | 11.7                        |                            
|                                     |                             |                           
+-------------------------------------+-----------------------------+
| Python                              | 3.9                         |                           
|                                     |                             |                           
+-------------------------------------+-----------------------------+


Microsoft Visual Studio Build and Runtime Requirements
======================================================

Starting from HOOPS 2023, HOOPS Exchange migrated its compiler to Visual Studio 2019 (previously 2015).
Following `Microsoft's Documentation <https://learn.microsoft.com/en-us/cpp/porting/binary-compat-2015-2017?view=msvc-170>`__ on binary compatibility, this change implies an update to the required MSVC redistributables.

HOOPS Exchange being an explicitly shared library, the impact occurs at runtime.
Any application running HOOPS Exchange such as **HOOPS AI** must have at least `Visual Studio 2019 redistributable <https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170>`__.



Package Description
===================

Here is a quick description of the package :

.. code-block:: text

     hoops_ai
     ├───cadaccess
     │   ├─── HOOPSLoader
     │   ├─── HOOPSModel
     │   ├─── HOOPSBrep
     │   └─── HOOPSTools
     ├───cadencoder
     │   └─── BrepEncoder
     ├───dataset
     │   ├─── DatasetLoader
     │   └─── DatasetExplorer
     ├───flowmanager
     │   ├─── @flowtask Decorators
     │   ├─── ParallelTask
     │   ├─── SequentialTask
     │   └─── ParallelExecutor
     ├───insights
     │   ├─── DatasetViewer
     │   ├─── CADViewer
     │   └─── ColorPalette
     ├───ml
     │   └───EXPERIMENTAL
     │       ├─── FlowModel
     │       ├─── FlowTrainer
     │       └─── FlowInference
     └───storage
          ├─── OptStorage
          ├─── MemoryStorage
          ├─── JsonStorageHandler
          ├─── SchemaBuilder
          └─── DatasetMerger

       

Module Documentation
====================

The ``hoops_ai`` package is organized into specialized modules that work together to transform CAD files into machine learning-ready datasets. For detailed documentation on each module, see the Programming Guide:

**Data Flow Management:**
   - :doc:`/programming_guide/cad-data-access` - CAD file loading with HOOPSLoader, HOOPSModel, HOOPSBrep, and HOOPSTools
   - :doc:`/programming_guide/cad-data-encoding` - Feature extraction with BrepEncoder
   - :doc:`/programming_guide/datasets` - Schema definition with SchemaBuilder
   - :doc:`/programming_guide/storage` - Data persistence with OptStorage, MemoryStorage, JsonStorageHandler, and DatasetMerger
   - :doc:`/programming_guide/flow` - Pipeline orchestration with @flowtask decorators, ParallelTask, SequentialTask, and ParallelExecutor

**Machine Learning:**
   - :doc:`/programming_guide/explore-dataset` - Dataset exploration with DatasetExplorer and DatasetLoader
   - :doc:`/programming_guide/train` - Model training with FlowModel, FlowTrainer, and FlowInference (EXPERIMENTAL)
   - :doc:`/programming_guide/part-class` - Part classification examples
   - :doc:`/programming_guide/feature-rec` - Feature recognition examples

**Visualization:**
   - :doc:`/programming_guide/cad-data-visualization` - Interactive visualization with DatasetViewer, CADViewer, and ColorPalette

Next Steps
==========

If you are already familiar with the :doc:`Supported Formats </getting_started/file_formats>` page, you are now ready to discover how to :doc:`Get Started with HOOPS AI </getting_started/evaluate>`.