ncsw_data.source.reaction.uspto.utility ======================================= .. py:module:: ncsw_data.source.reaction.uspto.utility .. autoapi-nested-parse:: The ``ncsw_data.source.reaction.uspto.utility`` package initialization module. Submodules ---------- .. toctree:: :maxdepth: 1 /autoapi/ncsw_data/source/reaction/uspto/utility/download/index /autoapi/ncsw_data/source/reaction/uspto/utility/extraction/index /autoapi/ncsw_data/source/reaction/uspto/utility/formatting/index Classes ------- .. autoapisummary:: ncsw_data.source.reaction.uspto.utility.USPTOReactionDatasetDownloadUtility ncsw_data.source.reaction.uspto.utility.USPTOReactionDatasetExtractionUtility ncsw_data.source.reaction.uspto.utility.USPTOReactionDatasetFormattingUtility Package Contents ---------------- .. py:class:: USPTOReactionDatasetDownloadUtility The `United States Patent and Trademark Office (USPTO) `_ chemical reaction dataset download utility class. .. py:method:: download_v_1976_to_2013_by_20121009_lowe_d_m(version: str, output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Download the data from a `v_1976_to_2013_*_by_20121009_lowe_d_m` version of 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:: download_v_50k_by_20141226_schneider_n_et_al(output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Download the data from the `v_50k_by_20141226_schneider_n_et_al` version of the dataset. :parameter output_directory_path: The path to the output directory where the data should be downloaded. .. py:method:: download_v_50k_by_20161122_schneider_n_et_al(output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Download the data from the `v_50k_by_20161122_schneider_n_et_al` version of the dataset. :parameter output_directory_path: The path to the output directory where the data should be downloaded. .. py:method:: download_v_15k_by_20170418_coley_c_w_et_al(output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Download the data from the `v_15k_by_20170418_coley_c_w_et_al` version of the dataset. :parameter output_directory_path: The path to the output directory where the data should be downloaded. .. py:method:: download_v_1976_to_2016_by_20121009_lowe_d_m(version: str, output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Download the data from a `v_1976_to_2016_*_by_20121009_lowe_d_m` version of 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:: download_v_50k_by_20170905_liu_b_et_al(output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Download the data from the `v_50k_by_20170905_liu_b_et_al` version of the dataset. :parameter output_directory_path: The path to the output directory where the data should be downloaded. .. py:method:: download_v_50k_by_20171116_coley_c_w_et_al(output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Download the data from the `v_50k_by_20171116_coley_c_w_et_al` version of the dataset. :parameter output_directory_path: The path to the output directory where the data should be downloaded. .. py:method:: download_v_480k_or_mit_by_20171204_jin_w_et_al(output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Download the data from the `v_480k_or_mit_by_20171204_jin_w_et_al` version of the dataset. :parameter output_directory_path: The path to the output directory where the data should be downloaded. .. py:method:: download_v_by_20180622_schwaller_p_et_al(output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Download the data from a `v_*_by_20180622_schwaller_p_et_al` version of the dataset. :parameter output_directory_path: The path to the output directory where the data should be downloaded. .. py:method:: download_v_lef_by_20181221_bradshaw_j_et_al(output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Download the data from the `v_lef_by_20181221_bradshaw_j_et_al` version of the dataset. :parameter output_directory_path: The path to the output directory where the data should be downloaded. .. py:method:: download_v_1k_tpl_by_20210128_schwaller_p_et_al(output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Download the data from the `v_1k_tpl_by_20210128_schwaller_p_et_al` version of the dataset. :parameter output_directory_path: The path to the output directory where the data should be downloaded. .. py:method:: download_v_1976_to_2016_remapped_by_20210407_schwaller_p_et_al(output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Download the data from the `v_1976_to_2016_remapped_by_20210407_schwaller_p_et_al` version of the chemical reaction dataset. :parameter output_directory_path: The path to the output directory where the data should be downloaded. .. py:method:: download_v_chen_s_et_al(version: str, output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Download the data from a `v_*_chen_s_et_al` version of 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:class:: USPTOReactionDatasetExtractionUtility The `United States Patent and Trademark Office (USPTO) `_ chemical reaction dataset extraction utility class. .. py:method:: extract_v_1976_to_2013_rsmi_by_20121009_lowe_d_m(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Extract the data from the `v_1976_to_2013_rsmi_by_20121009_lowe_d_m` 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:: extract_v_50k_by_20141226_schneider_n_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Extract the data from the `v_50k_by_20141226_schneider_n_et_al` 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:: extract_v_50k_by_20161122_schneider_n_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Extract the data from the `v_50k_by_20161122_schneider_n_et_al` 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:: extract_v_15k_by_20170418_coley_c_w_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Extract the data from the `v_15k_by_20170418_coley_c_w_et_al` 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:: extract_v_1976_to_2016_by_20121009_lowe_d_m(version: str, input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Extract the data from a `v_1976_to_2016_*_by_20121009_lowe_d_m` version of 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:: extract_v_480k_or_mit_by_20171204_jin_w_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Extract the data from the `v_480k_or_mit_by_20171204_jin_w_et_al` 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:: extract_v_by_20180622_schwaller_p_et_al(version: str, input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Extract the data from a `v_*_by_20180622_schwaller_p_et_al` version of 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:: extract_v_lef_by_20181221_bradshaw_j_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Extract the data from the `v_lef_by_20181221_bradshaw_j_et_al` 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:: extract_v_1k_tpl_by_20210128_schwaller_p_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Extract the data from the `v_1k_tpl_by_20210128_schwaller_p_et_al` 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:: extract_v_1976_to_2016_remapped_by_20210407_schwaller_p_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Extract the data from the `v_1976_to_2016_remapped_by_20210407_schwaller_p_et_al` 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:class:: USPTOReactionDatasetFormattingUtility The `United States Patent and Trademark Office (USPTO) `_ chemical reaction dataset formatting utility class. .. py:method:: format_v_1976_to_2013_rsmi_by_20121009_lowe_d_m(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Format the data from the `v_1976_to_2013_rsmi_by_20121009_lowe_d_m` 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. .. py:method:: format_v_50k_by_20141226_schneider_n_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Format the data from the `v_50k_by_20141226_schneider_n_et_al` 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. .. py:method:: format_v_50k_by_20161122_schneider_n_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Format the data from the `v_50k_by_20161122_schneider_n_et_al` 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. .. py:method:: format_v_15k_by_20170418_coley_c_w_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Format the data from the `v_15k_by_20170418_coley_c_w_et_al` 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. .. py:method:: _parse_v_1976_to_2016_cml_by_20121009_lowe_d_m_file(input_file_path: Union[str, os.PathLike[str]]) -> List[Tuple[Optional[Union[int, str]], Ellipsis]] :staticmethod: Parse a file from the `v_1976_to_2016_cml_by_20121009_lowe_d_m` version of the dataset. :parameter input_file_path: The path to the input file. :returns: The parsed input file. .. py:method:: format_v_1976_to_2016_by_20121009_lowe_d_m(version: str, input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]], number_of_processes: int = 1) -> None :staticmethod: Format the data from a `v_1976_to_2016_*_by_20121009_lowe_d_m` version of 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. :parameter number_of_processes: The number of processes. .. py:method:: format_v_50k_by_20170905_liu_b_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Format the data from the `v_50k_by_20170905_liu_b_et_al` 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. .. py:method:: format_v_50k_by_20171116_coley_c_w_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Format the data from the `v_50k_by_20171116_coley_c_w_et_al` 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. .. py:method:: format_v_480k_or_mit_by_20171204_jin_w_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Format the data from the `v_480k_or_mit_by_20171204_jin_w_et_al` 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. .. py:method:: format_v_by_20180622_schwaller_p_et_al(version: str, input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Format the data from a `v_*_by_20180622_schwaller_p_et_al` version of 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. .. py:method:: format_v_lef_by_20181221_bradshaw_j_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Format the data from the `v_lef_by_20181221_bradshaw_j_et_al` 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. .. py:method:: format_v_1k_tpl_by_20210128_schwaller_p_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Format the data from the `v_1k_tpl_by_20210128_schwaller_p_et_al` 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. .. py:method:: format_v_1976_to_2016_remapped_by_20210407_schwaller_p_et_al(input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Format the data from the `v_1976_to_2016_by_20210407_schwaller_p_et_al` version of the chemical reaction 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. .. py:method:: format_v_chen_s_et_al(version: str, input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None :staticmethod: Format the data from a `v_*_chen_s_et_al` version of 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.