tutorials.examples.train_chip_design
====================================

.. py:module:: tutorials.examples.train_chip_design


Attributes
----------

.. autoapisummary::

   tutorials.examples.train_chip_design.parser


Classes
-------

.. autoapisummary::

   tutorials.examples.train_chip_design.ChipDesignPreprocessor


Functions
---------

.. autoapisummary::

   tutorials.examples.train_chip_design.main


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

.. py:class:: ChipDesignPreprocessor(env, embedding_dim=64)

   Bases: :py:obj:`gfn.preprocessors.Preprocessor`


   Base class for state preprocessors.

   Preprocessors transform raw state tensors into formats suitable for neural network
   inputs. They handle the conversion from environment-specific state representations
   to standardized tensor formats that can be processed by neural networks.

   .. attribute:: output_dim

      The dimensionality of the preprocessed output tensor, which is
      compatible with the neural network that will be used. If None, the output
      dimension will not be checked.


   .. py:attribute:: embedding


   .. py:attribute:: embedding_dim
      :value: 64



   .. py:attribute:: n_macros


   .. py:method:: preprocess(states)

      Transforms the states to the input format for neural networks.

      :param states: The states to preprocess.

      :returns: A tensor of shape (*batch_shape, output_dim) containing the preprocessed
                states.



.. py:function:: main(args)

.. py:data:: parser