pyiqa.data.dataset_api
======================

.. py:module:: pyiqa.data.dataset_api






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

.. py:data:: dataset_download_name

.. py:function:: extract_archive(archive_path: str, extract_path: Optional[str] = None) -> bool

   Extract .zip, .tar, or .tgz files with a progress bar.

   :param archive_path: Path to the archive file
   :type archive_path: str
   :param extract_path: Extraction destination. Defaults to current directory.
   :type extract_path: str, optional

   :returns: True if extraction successful, False otherwise
   :rtype: bool


.. py:function:: load_dataset(name: str, data_root: str = './datasets', force_download: bool = False, dataset_opts: Optional[Dict[str, Any]] = None, **kwargs: Any) -> Any

   Load a dataset from specified location, downloading if necessary.

   :param name: Name of the dataset to load
   :type name: str
   :param data_root: Root directory for dataset storage
   :type data_root: str
   :param force_download: Whether to force download even if files exist
   :type force_download: bool
   :param dataset_opts: Additional dataset options
   :type dataset_opts: Optional[Dict[str, Any]]
   :param \*\*kwargs: Additional arguments passed to dataset configuration
   :type \*\*kwargs: Any

   :returns: Dataset object
   :rtype: Any