mani_skill.utils.assets
=======================

.. py:module:: mani_skill.utils.assets


Submodules
----------

.. toctree::
   :maxdepth: 1

   /api/mani_skill/utils/assets/data/index


Attributes
----------

.. autoapisummary::

   mani_skill.utils.assets.DATA_GROUPS
   mani_skill.utils.assets.DATA_SOURCES


Classes
-------

.. autoapisummary::

   mani_skill.utils.assets.DataSource


Functions
---------

.. autoapisummary::

   mani_skill.utils.assets.expand_data_group_into_individual_data_source_ids
   mani_skill.utils.assets.is_data_source_downloaded


Package Contents
----------------

.. py:class:: DataSource

   .. py:attribute:: checksum
      :type:  Optional[str]
      :value: None



   .. py:attribute:: filename
      :type:  Optional[str]
      :value: None


      name to change the downloaded file to. If None, will not change the name


   .. py:attribute:: github_url
      :type:  Optional[str]
      :value: None



   .. py:attribute:: hf_repo_id
      :type:  Optional[str]
      :value: None



   .. py:attribute:: output_dir
      :type:  str


   .. py:attribute:: source_type
      :type:  str

      what kind of data is this


   .. py:attribute:: target_path
      :type:  Optional[str]
      :value: None


      the folder where the file will be downloaded to


   .. py:attribute:: url
      :type:  Optional[str]
      :value: None



   .. py:attribute:: zip_dirname
      :type:  Optional[str]
      :value: None


      what to rename a zip files generated directory to


.. py:function:: expand_data_group_into_individual_data_source_ids(data_group_id)

   Expand a data group into a list of individual data source IDs


.. py:function:: is_data_source_downloaded(data_source_id)

.. py:data:: DATA_GROUPS
   :type:  dict[str, list[str]]

   Data groups map group ids (typically environment IDs) to a list of data source/group IDs for easy group management. data groups can be done hierarchicaly

.. py:data:: DATA_SOURCES
   :type:  dict[str, DataSource]

   Data sources map data source IDs to their respective DataSource objects which contain info on what the data is and where to download it