:py:mod:`hlsfactory.datasets_builtin`
=====================================

.. py:module:: hlsfactory.datasets_builtin

.. autodoc2-docstring:: hlsfactory.datasets_builtin
   :allowtitles:

Module Contents
---------------

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`check_dataset_dir_exists <hlsfactory.datasets_builtin.check_dataset_dir_exists>`
     - .. autodoc2-docstring:: hlsfactory.datasets_builtin.check_dataset_dir_exists
          :summary:
   * - :py:obj:`dataset_polybench_builder <hlsfactory.datasets_builtin.dataset_polybench_builder>`
     - .. autodoc2-docstring:: hlsfactory.datasets_builtin.dataset_polybench_builder
          :summary:
   * - :py:obj:`dataset_machsuite_builder <hlsfactory.datasets_builtin.dataset_machsuite_builder>`
     - .. autodoc2-docstring:: hlsfactory.datasets_builtin.dataset_machsuite_builder
          :summary:
   * - :py:obj:`dataset_chstone_builder <hlsfactory.datasets_builtin.dataset_chstone_builder>`
     - .. autodoc2-docstring:: hlsfactory.datasets_builtin.dataset_chstone_builder
          :summary:
   * - :py:obj:`dataset_pp4fpgas_builder <hlsfactory.datasets_builtin.dataset_pp4fpgas_builder>`
     - .. autodoc2-docstring:: hlsfactory.datasets_builtin.dataset_pp4fpgas_builder
          :summary:
   * - :py:obj:`dataset_vitis_examples_builder <hlsfactory.datasets_builtin.dataset_vitis_examples_builder>`
     - .. autodoc2-docstring:: hlsfactory.datasets_builtin.dataset_vitis_examples_builder
          :summary:
   * - :py:obj:`dataset_accelerators_builder <hlsfactory.datasets_builtin.dataset_accelerators_builder>`
     - .. autodoc2-docstring:: hlsfactory.datasets_builtin.dataset_accelerators_builder
          :summary:
   * - :py:obj:`datasets_builder <hlsfactory.datasets_builtin.datasets_builder>`
     - .. autodoc2-docstring:: hlsfactory.datasets_builtin.datasets_builder
          :summary:
   * - :py:obj:`datasets_all_builder <hlsfactory.datasets_builtin.datasets_all_builder>`
     - .. autodoc2-docstring:: hlsfactory.datasets_builtin.datasets_all_builder
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`CURRENT_FP <hlsfactory.datasets_builtin.CURRENT_FP>`
     - .. autodoc2-docstring:: hlsfactory.datasets_builtin.CURRENT_FP
          :summary:
   * - :py:obj:`CURRENT_DIR <hlsfactory.datasets_builtin.CURRENT_DIR>`
     - .. autodoc2-docstring:: hlsfactory.datasets_builtin.CURRENT_DIR
          :summary:
   * - :py:obj:`HLS_DATASET_DIR <hlsfactory.datasets_builtin.HLS_DATASET_DIR>`
     - .. autodoc2-docstring:: hlsfactory.datasets_builtin.HLS_DATASET_DIR
          :summary:
   * - :py:obj:`DIR_DATASET_POLYBENCH <hlsfactory.datasets_builtin.DIR_DATASET_POLYBENCH>`
     - .. autodoc2-docstring:: hlsfactory.datasets_builtin.DIR_DATASET_POLYBENCH
          :summary:
   * - :py:obj:`DIR_DATASET_MACHSUITE <hlsfactory.datasets_builtin.DIR_DATASET_MACHSUITE>`
     - .. autodoc2-docstring:: hlsfactory.datasets_builtin.DIR_DATASET_MACHSUITE
          :summary:
   * - :py:obj:`DIR_DATASET_CHSTONE <hlsfactory.datasets_builtin.DIR_DATASET_CHSTONE>`
     - .. autodoc2-docstring:: hlsfactory.datasets_builtin.DIR_DATASET_CHSTONE
          :summary:
   * - :py:obj:`DIR_DATASET_PP4FPGAS <hlsfactory.datasets_builtin.DIR_DATASET_PP4FPGAS>`
     - .. autodoc2-docstring:: hlsfactory.datasets_builtin.DIR_DATASET_PP4FPGAS
          :summary:
   * - :py:obj:`DIR_DATASET_VITIS_EXAMPLES <hlsfactory.datasets_builtin.DIR_DATASET_VITIS_EXAMPLES>`
     - .. autodoc2-docstring:: hlsfactory.datasets_builtin.DIR_DATASET_VITIS_EXAMPLES
          :summary:
   * - :py:obj:`DIR_DATASET_ACCELERATORS <hlsfactory.datasets_builtin.DIR_DATASET_ACCELERATORS>`
     - .. autodoc2-docstring:: hlsfactory.datasets_builtin.DIR_DATASET_ACCELERATORS
          :summary:
   * - :py:obj:`DIR_ALL <hlsfactory.datasets_builtin.DIR_ALL>`
     - .. autodoc2-docstring:: hlsfactory.datasets_builtin.DIR_ALL
          :summary:
   * - :py:obj:`DATASET_STR_MAP <hlsfactory.datasets_builtin.DATASET_STR_MAP>`
     - .. autodoc2-docstring:: hlsfactory.datasets_builtin.DATASET_STR_MAP
          :summary:

API
~~~

.. py:data:: CURRENT_FP
   :canonical: hlsfactory.datasets_builtin.CURRENT_FP
   :value: 'resolve(...)'

   .. autodoc2-docstring:: hlsfactory.datasets_builtin.CURRENT_FP

.. py:data:: CURRENT_DIR
   :canonical: hlsfactory.datasets_builtin.CURRENT_DIR
   :value: None

   .. autodoc2-docstring:: hlsfactory.datasets_builtin.CURRENT_DIR

.. py:data:: HLS_DATASET_DIR
   :canonical: hlsfactory.datasets_builtin.HLS_DATASET_DIR
   :value: None

   .. autodoc2-docstring:: hlsfactory.datasets_builtin.HLS_DATASET_DIR

.. py:data:: DIR_DATASET_POLYBENCH
   :canonical: hlsfactory.datasets_builtin.DIR_DATASET_POLYBENCH
   :value: None

   .. autodoc2-docstring:: hlsfactory.datasets_builtin.DIR_DATASET_POLYBENCH

.. py:data:: DIR_DATASET_MACHSUITE
   :canonical: hlsfactory.datasets_builtin.DIR_DATASET_MACHSUITE
   :value: None

   .. autodoc2-docstring:: hlsfactory.datasets_builtin.DIR_DATASET_MACHSUITE

.. py:data:: DIR_DATASET_CHSTONE
   :canonical: hlsfactory.datasets_builtin.DIR_DATASET_CHSTONE
   :value: None

   .. autodoc2-docstring:: hlsfactory.datasets_builtin.DIR_DATASET_CHSTONE

.. py:data:: DIR_DATASET_PP4FPGAS
   :canonical: hlsfactory.datasets_builtin.DIR_DATASET_PP4FPGAS
   :value: None

   .. autodoc2-docstring:: hlsfactory.datasets_builtin.DIR_DATASET_PP4FPGAS

.. py:data:: DIR_DATASET_VITIS_EXAMPLES
   :canonical: hlsfactory.datasets_builtin.DIR_DATASET_VITIS_EXAMPLES
   :value: None

   .. autodoc2-docstring:: hlsfactory.datasets_builtin.DIR_DATASET_VITIS_EXAMPLES

.. py:data:: DIR_DATASET_ACCELERATORS
   :canonical: hlsfactory.datasets_builtin.DIR_DATASET_ACCELERATORS
   :value: None

   .. autodoc2-docstring:: hlsfactory.datasets_builtin.DIR_DATASET_ACCELERATORS

.. py:data:: DIR_ALL
   :canonical: hlsfactory.datasets_builtin.DIR_ALL
   :value: None

   .. autodoc2-docstring:: hlsfactory.datasets_builtin.DIR_ALL

.. py:function:: check_dataset_dir_exists(dir_path: pathlib.Path) -> None
   :canonical: hlsfactory.datasets_builtin.check_dataset_dir_exists

   .. autodoc2-docstring:: hlsfactory.datasets_builtin.check_dataset_dir_exists

.. py:function:: dataset_polybench_builder(name: str, work_dir: pathlib.Path) -> hlsfactory.framework.DesignDataset
   :canonical: hlsfactory.datasets_builtin.dataset_polybench_builder

   .. autodoc2-docstring:: hlsfactory.datasets_builtin.dataset_polybench_builder

.. py:function:: dataset_machsuite_builder(name: str, work_dir: pathlib.Path) -> hlsfactory.framework.DesignDataset
   :canonical: hlsfactory.datasets_builtin.dataset_machsuite_builder

   .. autodoc2-docstring:: hlsfactory.datasets_builtin.dataset_machsuite_builder

.. py:function:: dataset_chstone_builder(name: str, work_dir: pathlib.Path) -> hlsfactory.framework.DesignDataset
   :canonical: hlsfactory.datasets_builtin.dataset_chstone_builder

   .. autodoc2-docstring:: hlsfactory.datasets_builtin.dataset_chstone_builder

.. py:function:: dataset_pp4fpgas_builder(name: str, work_dir: pathlib.Path) -> hlsfactory.framework.DesignDataset
   :canonical: hlsfactory.datasets_builtin.dataset_pp4fpgas_builder

   .. autodoc2-docstring:: hlsfactory.datasets_builtin.dataset_pp4fpgas_builder

.. py:function:: dataset_vitis_examples_builder(name: str, work_dir: pathlib.Path) -> hlsfactory.framework.DesignDataset
   :canonical: hlsfactory.datasets_builtin.dataset_vitis_examples_builder

   .. autodoc2-docstring:: hlsfactory.datasets_builtin.dataset_vitis_examples_builder

.. py:function:: dataset_accelerators_builder(name: str, work_dir: pathlib.Path) -> hlsfactory.framework.DesignDataset
   :canonical: hlsfactory.datasets_builtin.dataset_accelerators_builder

   .. autodoc2-docstring:: hlsfactory.datasets_builtin.dataset_accelerators_builder

.. py:data:: DATASET_STR_MAP
   :canonical: hlsfactory.datasets_builtin.DATASET_STR_MAP
   :value: None

   .. autodoc2-docstring:: hlsfactory.datasets_builtin.DATASET_STR_MAP

.. py:function:: datasets_builder(work_dir: pathlib.Path, dataset_names: list[str], dataset_labels: list[str] | None = None) -> hlsfactory.framework.DesignDatasetCollection
   :canonical: hlsfactory.datasets_builtin.datasets_builder

   .. autodoc2-docstring:: hlsfactory.datasets_builtin.datasets_builder

.. py:function:: datasets_all_builder(work_dir: pathlib.Path) -> hlsfactory.framework.DesignDatasetCollection
   :canonical: hlsfactory.datasets_builtin.datasets_all_builder

   .. autodoc2-docstring:: hlsfactory.datasets_builtin.datasets_all_builder