ncsw_data.source.reaction.uspto
===============================

.. py:module:: ncsw_data.source.reaction.uspto

.. autoapi-nested-parse::

   The ``ncsw_data.source.reaction.uspto`` package initialization module. 



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/ncsw_data/source/reaction/uspto/uspto/index
   /autoapi/ncsw_data/source/reaction/uspto/utility/index


Classes
-------

.. autoapisummary::

   ncsw_data.source.reaction.uspto.USPTOReactionDataset


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

.. py:class:: USPTOReactionDataset(logger: Optional[logging.Logger] = None)

   Bases: :py:obj:`ncsw_data.source.base.base.DataSourceBase`


   The `United States Patent and Trademark Office (USPTO) <https://www.repository.cam.ac.uk/handle/1810/244727>`_
   chemical reaction dataset class.

   The `__init__` method of the class.

   :parameter logger: The logger. The value `None` indicates that the logger should not be utilized.


   .. py:method:: get_supported_versions() -> Dict[str, str]
      :staticmethod:


      Get the supported versions of the dataset.

      :returns: The supported versions of the dataset.



   .. py:method:: download(version: str, output_directory_path: Union[str, os.PathLike[str]], **kwargs) -> None

      Download the data from the dataset.

      :parameter version: The version of the dataset.
      :parameter output_directory_path: The path to the output directory where the data should be downloaded.



   .. py:method:: extract(version: str, input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]], **kwargs) -> None

      Extract the data from the dataset.

      :parameter version: The version of the dataset.
      :parameter input_directory_path: The path to the input directory where the data is downloaded.
      :parameter output_directory_path: The path to the output directory where the data should be extracted.



   .. py:method:: format(version: str, input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]], **kwargs) -> None

      Format the data from the dataset.

      :parameter version: The version of the dataset.
      :parameter input_directory_path: The path to the input directory where the data is extracted.
      :parameter output_directory_path: The path to the output directory where the data should be formatted.