piscis.downloads
================

.. py:module:: piscis.downloads


Functions
---------

.. autoapisummary::

   piscis.downloads.download_pretrained_model
   piscis.downloads.list_pretrained_models
   piscis.downloads.download_dataset
   piscis.downloads.list_datasets


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

.. py:function:: download_pretrained_model(model_name: str) -> None

   
   Download a pretrained model from Hugging Face.


   :Parameters:

       **model_name** : str
           Model name.







   :Raises:

       ValueError
           If `model_name` is not found.







   ..
       !! processed by numpydoc !!

.. py:function:: list_pretrained_models() -> Sequence[str]

   
   List pretrained models from Hugging Face.





   :Returns:

       **pretrained_models** : Sequence[str]
           List of pretrained model names.











   ..
       !! processed by numpydoc !!

.. py:function:: download_dataset(dataset_name: str, path: str, minimal_download: bool = True) -> None

   
   Download a dataset from Hugging Face.


   :Parameters:

       **dataset_name** : str
           Dataset name.

       **path** : str
           Path to save the dataset.







   :Raises:

       ValueError
           If `dataset_name` is not found.







   ..
       !! processed by numpydoc !!

.. py:function:: list_datasets() -> Sequence[str]

   
   List datasets from Hugging Face.





   :Returns:

       **datasets** : Sequence[str]
           List of dataset names.











   ..
       !! processed by numpydoc !!