From 4ce901a88dfe0061315dd3120449380cbf66e79f Mon Sep 17 00:00:00 2001 From: Zenulous Date: Mon, 12 Feb 2024 15:59:29 +0000 Subject: [PATCH] deploy: 8313d805cdb9488d9b2fafa8f0d06498e2066fbd --- evaluators/index.html | 4 +-- evaluators/ld1nn.html | 4 +-- generators/index.html | 4 +-- generators/wuggygenerator.html | 57 +++++++++++++++++---------------- index.html | 4 +-- plugins/baselanguageplugin.html | 4 +-- plugins/index.html | 4 +-- utilities/bigramchain.html | 4 +-- utilities/index.html | 4 +-- 9 files changed, 46 insertions(+), 43 deletions(-) diff --git a/evaluators/index.html b/evaluators/index.html index 4901ea7..36dd8c5 100644 --- a/evaluators/index.html +++ b/evaluators/index.html @@ -3,7 +3,7 @@ - + wuggy.evaluators API documentation @@ -69,7 +69,7 @@

Index

\ No newline at end of file diff --git a/evaluators/ld1nn.html b/evaluators/ld1nn.html index 30547df..facc33c 100644 --- a/evaluators/ld1nn.html +++ b/evaluators/ld1nn.html @@ -3,7 +3,7 @@ - + wuggy.evaluators.ld1nn API documentation @@ -240,7 +240,7 @@

Index

\ No newline at end of file diff --git a/generators/index.html b/generators/index.html index d956df5..5173355 100644 --- a/generators/index.html +++ b/generators/index.html @@ -3,7 +3,7 @@ - + wuggy.generators API documentation @@ -69,7 +69,7 @@

Index

\ No newline at end of file diff --git a/generators/wuggygenerator.html b/generators/wuggygenerator.html index 307a836..fec5b3e 100644 --- a/generators/wuggygenerator.html +++ b/generators/wuggygenerator.html @@ -3,7 +3,7 @@ - + wuggy.generators.wuggygenerator API documentation @@ -94,7 +94,7 @@

Module wuggy.generators.wuggygenerator

"phonetic_english_cmu", "phonetic_french", "phonetic_italian"] - self.__official_language_plugin_repository_url = "https://raw.githubusercontent.com/WuggyCode/wuggy_language_plugin_data/master/" + self.__official_language_plugin_repository_url = "https://raw.githubusercontent.com/WuggyCode/wuggy_language_plugin_data/master" self.attribute_subchain = None self.frequency_subchain = None self.reference_sequence = None @@ -210,8 +210,9 @@

Module wuggy.generators.wuggygenerator

print( f"Wuggy is currently downloading the plugin {language_plugin_name} for you from the official repository...") - + py_file_name = f"{language_plugin_name}.py" + print(f"{self.__official_language_plugin_repository_url}/{language_plugin_name}/{py_file_name}") py_file = urlopen( f"{self.__official_language_plugin_repository_url}/{language_plugin_name}/{py_file_name}") @@ -729,7 +730,7 @@

Classes

"phonetic_english_cmu", "phonetic_french", "phonetic_italian"] - self.__official_language_plugin_repository_url = "https://raw.githubusercontent.com/WuggyCode/wuggy_language_plugin_data/master/" + self.__official_language_plugin_repository_url = "https://raw.githubusercontent.com/WuggyCode/wuggy_language_plugin_data/master" self.attribute_subchain = None self.frequency_subchain = None self.reference_sequence = None @@ -845,8 +846,9 @@

Classes

print( f"Wuggy is currently downloading the plugin {language_plugin_name} for you from the official repository...") - + py_file_name = f"{language_plugin_name}.py" + print(f"{self.__official_language_plugin_repository_url}/{language_plugin_name}/{py_file_name}") py_file = urlopen( f"{self.__official_language_plugin_repository_url}/{language_plugin_name}/{py_file_name}") @@ -1329,7 +1331,7 @@

Classes

Static methods

-def remove_downloaded_language_plugins() ‑> NoneType +def remove_downloaded_language_plugins() ‑> None

Removes all downloaded (official) language plugins. @@ -1355,7 +1357,7 @@

Static methods

Methods

-def apply_frequency_filter(self) ‑> NoneType +def apply_frequency_filter(self) ‑> None

Apply the previously set frequency filter.

@@ -1376,7 +1378,7 @@

Methods

-def apply_statistics(self, sequence: str = None) ‑> NoneType +def apply_statistics(self, sequence: str = None) ‑> None

Apply all statistics which were set beforehand.

@@ -1406,7 +1408,7 @@

Methods

-def clear_attribute_filters(self) ‑> NoneType +def clear_attribute_filters(self) ‑> None

Remove all set attribute filters.

@@ -1422,7 +1424,7 @@

Methods

-def clear_frequency_filter(self) ‑> NoneType +def clear_frequency_filter(self) ‑> None

Clear the previously set frequency filter.

@@ -1439,7 +1441,7 @@

Methods

-def clear_statistics(self) ‑> NoneType +def clear_statistics(self) ‑> None

Clear all the statistics set previously.

@@ -1455,7 +1457,7 @@

Methods

-def download_language_plugin(self, language_plugin_name: str, auto_download=False) ‑> NoneType +def download_language_plugin(self, language_plugin_name: str, auto_download=False) ‑> None

Downloads and saves given language plugin to local storage from the corresponding official file repository. @@ -1507,8 +1509,9 @@

Parameters

print( f"Wuggy is currently downloading the plugin {language_plugin_name} for you from the official repository...") - + py_file_name = f"{language_plugin_name}.py" + print(f"{self.__official_language_plugin_repository_url}/{language_plugin_name}/{py_file_name}") py_file = urlopen( f"{self.__official_language_plugin_repository_url}/{language_plugin_name}/{py_file_name}") @@ -1530,7 +1533,7 @@

Parameters

-def export_classic_pseudoword_matches_to_csv(self, pseudoword_matches: [typing.Dict], csv_path: str) ‑> NoneType +def export_classic_pseudoword_matches_to_csv(self, pseudoword_matches: [typing.Dict], csv_path: str) ‑> None

Helper function to export generated pseudoword matches from generate_classic to CSV. @@ -1591,7 +1594,7 @@

Parameters

-def generate_advanced(self, clear_cache: bool = True) ‑> Union[Generator[str, NoneType, NoneType], Generator[tuple, NoneType, NoneType]] +def generate_advanced(self, clear_cache: bool = True) ‑> Union[Generator[str, None, None], Generator[tuple, None, None]]

Creates a custom generator which can be iterated to return generated pseudowords. @@ -1702,7 +1705,7 @@

Generating Pseudowords (w

-def generate_classic(self, input_sequences: [], ncandidates_per_sequence: int = 10, max_search_time_per_sequence: int = 10, subsyllabic_segment_overlap_ratio: Union[fractions.Fraction, NoneType] = Fraction(2, 3), match_subsyllabic_segment_length: bool = True, match_letter_length: bool = True, output_mode: str = 'plain', concentric_search: bool = True) ‑> [typing.Dict] +def generate_classic(self, input_sequences: [], ncandidates_per_sequence: int = 10, max_search_time_per_sequence: int = 10, subsyllabic_segment_overlap_ratio: Optional[fractions.Fraction] = Fraction(2, 3), match_subsyllabic_segment_length: bool = True, match_letter_length: bool = True, output_mode: str = 'plain', concentric_search: bool = True) ‑> [typing.Dict]

This is the classic method to generate pseudowords using Wuggy and can be called immediately after loading a language plugin. @@ -1842,7 +1845,7 @@

Generating pseudowords and

-def load(self, language_plugin_name: str, local_language_plugin: BaseLanguagePlugin = None) ‑> NoneType +def load(self, language_plugin_name: str, local_language_plugin: BaseLanguagePlugin = None) ‑> None

Loads in a language plugin, if available, and stores the corresponding bigramchains.

@@ -1899,7 +1902,7 @@

Parameters

-def lookup_reference_segments(self, reference: str) ‑> Union[str, NoneType] +def lookup_reference_segments(self, reference: str) ‑> Optional[str]

Look up a given reference (word) from the currently active lookup lexicon. @@ -1919,7 +1922,7 @@

Parameters

-def set_all_statistics(self) ‑> NoneType +def set_all_statistics(self) ‑> None

Enable all statistics supported by the current active language plugin. @@ -1937,7 +1940,7 @@

Parameters

-def set_attribute_filter(self, name: str) ‑> NoneType +def set_attribute_filter(self, name: str) ‑> None

Set an attribute filter supported by the currently activated language plugin.

@@ -1958,7 +1961,7 @@

Parameters

-def set_attribute_filters(self, names: []) ‑> NoneType +def set_attribute_filters(self, names: []) ‑> None

Set attribute filters supported by the currently activated language plugin.

@@ -1975,7 +1978,7 @@

Parameters

-def set_frequency_filter(self, lower: int, upper: int) ‑> NoneType +def set_frequency_filter(self, lower: int, upper: int) ‑> None

Sets the frequency filter for concentric search. @@ -1993,7 +1996,7 @@

Parameters

-def set_output_mode(self, name: str) ‑> NoneType +def set_output_mode(self, name: str) ‑> None

Set an output mode supported by the currently activated language plugin.

@@ -2011,7 +2014,7 @@

Parameters

-def set_reference_sequence(self, sequence: str) ‑> NoneType +def set_reference_sequence(self, sequence: str) ‑> None

Set the reference sequence. @@ -2038,7 +2041,7 @@

Parameters

-def set_statistic(self, name: str) ‑> NoneType +def set_statistic(self, name: str) ‑> None

Enable a statistic based on its name.

@@ -2056,7 +2059,7 @@

Parameters

-def set_statistics(self, names: []) ‑> NoneType +def set_statistics(self, names: []) ‑> None

Enables statistics based on their names.

@@ -2135,7 +2138,7 @@

-

Generated by pdoc 0.9.1.

+

Generated by pdoc 0.10.0.

\ No newline at end of file diff --git a/index.html b/index.html index 7975957..2425eec 100644 --- a/index.html +++ b/index.html @@ -3,7 +3,7 @@ - + wuggy API documentation @@ -343,7 +343,7 @@

Index

\ No newline at end of file diff --git a/plugins/baselanguageplugin.html b/plugins/baselanguageplugin.html index 14f77d9..b908959 100644 --- a/plugins/baselanguageplugin.html +++ b/plugins/baselanguageplugin.html @@ -3,7 +3,7 @@ - + wuggy.plugins.baselanguageplugin API documentation @@ -855,7 +855,7 @@

-

Generated by pdoc 0.9.1.

+

Generated by pdoc 0.10.0.

\ No newline at end of file diff --git a/plugins/index.html b/plugins/index.html index ae0e0a5..dbd9e04 100644 --- a/plugins/index.html +++ b/plugins/index.html @@ -3,7 +3,7 @@ - + wuggy.plugins API documentation @@ -69,7 +69,7 @@

Index

\ No newline at end of file diff --git a/utilities/bigramchain.html b/utilities/bigramchain.html index 803feb2..4f60981 100644 --- a/utilities/bigramchain.html +++ b/utilities/bigramchain.html @@ -3,7 +3,7 @@ - + wuggy.utilities.bigramchain API documentation @@ -727,7 +727,7 @@

-

Generated by pdoc 0.9.1.

+

Generated by pdoc 0.10.0.

\ No newline at end of file diff --git a/utilities/index.html b/utilities/index.html index 7d10d11..b480a08 100644 --- a/utilities/index.html +++ b/utilities/index.html @@ -3,7 +3,7 @@ - + wuggy.utilities API documentation @@ -69,7 +69,7 @@

Index

\ No newline at end of file