Deploying to gh-pages from @ e71688e 🚀

_sources/experiments/index.rst.txt

@@ -6,7 +6,7 @@ Follow these steps to reproduce the experiments in our paper.
 1. Obtain the external resources
 --------------------------------
 
-Follow the instructions in the ":doc:`/getting-started/resources`" page in the documentation
+Follow the instructions in the ":doc:`resources`" page in the documentation
 to obtain the resources required for running the experiments.
 
 2. Preparing the data
@@ -17,7 +17,7 @@ run the following command from the ``./experiments/`` folder:
 
 .. code-block:: bash
 
-    $ python ./prepare_data.py -p ../resources
+    $ python ./prepare_data.py
 
 This script takes care of downloading the LwM and HIPE datasets and format them
 as needed in the experiments.
@@ -30,7 +30,7 @@ folder:
 
 .. code-block:: bash
 
-    $ python ./toponym_resolution.py -p ../resources
+    $ python ./toponym_resolution.py
 
 This script does runs for all different scenarios reported in the experiments in
 the paper.

_sources/getting-started/complete-tour.rst.txt

@@ -47,9 +47,7 @@ To instantiate the default T-Res pipeline, do:
 
     from geoparser import pipeline
 
-    geoparser = pipeline.Pipeline(resources_path="../resources/")
-
-.. note:: You should update the resources path argument to reflect your set up.
+    geoparser = pipeline.Pipeline()
 
 You can also instantiate a pipeline using a customised Recogniser, Ranker and
 Linker. To see the different options, refer to the sections on instantiating
@@ -605,7 +603,7 @@ and ``levenshtein`` respectively), instantiate it as follows, changing the
 
     myranker = ranking.Ranker(
         method="perfectmatch", # or "partialmatch" or "levenshtein"
-        resources_path="resources/",
+        resources_path="resources/wikidata/",
     )
 
 Note that ``resources_path`` should contain the path to the directory
@@ -670,7 +668,7 @@ The Ranker can then be instantiated as follows:
     myranker = ranking.Ranker(
         # Generic Ranker parameters:
         method="deezymatch",
-        resources_path="resources/",
+        resources_path="resources/wikidata/",
         # Parameters to create the string pair dataset:
         strvar_parameters=dict(),
         # Parameters to train, load and use a DeezyMatch model:
@@ -759,7 +757,7 @@ The Ranker can then be instantiated as follows:
     myranker = ranking.Ranker(
         # Generic Ranker parameters:
         method="deezymatch",
-        resources_path="resources/",
+        resources_path="resources/wikidata/",
         # Parameters to create the string pair dataset:
         strvar_parameters={
             "ocr_threshold": 60,
@@ -1058,7 +1056,7 @@ of the Linker method.
 
 .. code-block:: python
 
-    mylinker.load_resources()
+    mylinker.linking_resources = mylinker.load_resources()
 
 .. note::
 

_sources/getting-started/resources.rst.txt

@@ -561,9 +561,6 @@ for the mentioned resources that are required in order to run the pipeline.
 ::
 
     T-Res/
-    ├── t-res/
-    │   ├── geoparser/
-    │   └── utils/
     ├── app/
     ├── evaluation/
     ├── examples/
@@ -574,6 +571,7 @@ for the mentioned resources that are required in order to run the pipeline.
     │               ├── linking_df_split.tsv [*?]
     │               ├── ner_fine_dev.json [*+?]
     │               └── ner_fine_train.json [*+?]
+    ├── geoparser/
     ├── resources/
     │   ├── deezymatch/
     │   │   └── data/
@@ -588,7 +586,8 @@ for the mentioned resources that are required in order to run the pipeline.
     │       ├── mentions_to_wikidata.json [*]
     │       ├── wikidta_gazetteer.csv [*]
     │       └── wikidata_to_mentions_normalized.json [*]
-    └── tests/
+    ├── tests/
+    └── utils/
 
 A question mark (``?``) is used to indicate resources which are only required
 for some approaches (for example, the ``rel_db/embeddings_database.db`` file

_sources/reference/geoparser/linker.rst.txt

@@ -1,8 +1,8 @@
-``t_res.geoparser.linking.Linker``
+``geoparser.linking.Linker``
 ============================
 
-.. autoclass:: t_res.geoparser.linking.Linker
+.. autoclass:: geoparser.linking.Linker
     :members:
     :undoc-members:
 
-.. autoattribute:: t_res.geoparser.linking.RANDOM_SEED
+.. autoattribute:: geoparser.linking.RANDOM_SEED

_sources/reference/geoparser/pipeline.rst.txt

@@ -1,6 +1,6 @@
-``t_res.geoparser.pipeline.Pipeline``
+``geoparser.pipeline.Pipeline``
 ===============================
 
-.. autoclass:: t_res.geoparser.pipeline.Pipeline
+.. autoclass:: geoparser.pipeline.Pipeline
     :members:
     :undoc-members:

_sources/reference/geoparser/ranker.rst.txt

@@ -1,6 +1,6 @@
-``t_res.geoparser.ranking. Ranker``
+``geoparser.ranking. Ranker``
 =============================
 
-.. autoclass:: t_res.geoparser.ranking.Ranker
+.. autoclass:: geoparser.ranking.Ranker
     :members:
     :undoc-members:

_sources/reference/geoparser/recogniser.rst.txt

@@ -1,6 +1,6 @@
-``t_res.geoparser.recogniser.Recogniser``
+``geoparser.recogniser.Recogniser``
 ===================================
 
-.. autoclass:: t_res.geoparser.recogniser.Recogniser
+.. autoclass:: geoparser.recogniser.Recogniser
     :members:
     :undoc-members:

_sources/reference/utils/deezy_processing.rst.txt

@@ -1,10 +1,10 @@
-``t_res.utils.deezy_processing`` module
+``utils.deezy_processing`` module
 =================================
 
-.. autofunction:: t_res.utils.deezy_processing.obtain_matches
+.. autofunction:: utils.deezy_processing.obtain_matches
 
-.. autofunction:: t_res.utils.deezy_processing.create_training_set
+.. autofunction:: utils.deezy_processing.create_training_set
 
-.. autofunction:: t_res.utils.deezy_processing.train_deezy_model
+.. autofunction:: utils.deezy_processing.train_deezy_model
 
-.. autofunction:: t_res.utils.deezy_processing.generate_candidates
+.. autofunction:: utils.deezy_processing.generate_candidates

_sources/reference/utils/get_data.rst.txt

@@ -1,6 +1,6 @@
-``t_res.utils.get_data`` module
+``utils.get_data`` module
 =========================
 
-.. autofunction:: t_res.utils.get_data.download_lwm_data
+.. autofunction:: utils.get_data.download_lwm_data
 
-.. autofunction:: t_res.utils.get_data.download_hipe_data
+.. autofunction:: utils.get_data.download_hipe_data

_sources/reference/utils/ner.rst.txt

@@ -1,18 +1,18 @@
-``t_res.utils.ner`` module
+``utils.ner`` module
 ====================
 
-.. autofunction:: t_res.utils.ner.training_tokenize_and_align_labels
+.. autofunction:: utils.ner.training_tokenize_and_align_labels
 
-.. autofunction:: t_res.utils.ner.collect_named_entities
+.. autofunction:: utils.ner.collect_named_entities
 
-.. autofunction:: t_res.utils.ner.aggregate_mentions
+.. autofunction:: utils.ner.aggregate_mentions
 
-.. autofunction:: t_res.utils.ner.fix_capitalization
+.. autofunction:: utils.ner.fix_capitalization
 
-.. autofunction:: t_res.utils.ner.fix_hyphens
+.. autofunction:: utils.ner.fix_hyphens
 
-.. autofunction:: t_res.utils.ner.fix_nested
+.. autofunction:: utils.ner.fix_nested
 
-.. autofunction:: t_res.utils.ner.fix_startEntity
+.. autofunction:: utils.ner.fix_startEntity
 
-.. autofunction:: t_res.utils.ner.aggregate_entities
+.. autofunction:: utils.ner.aggregate_entities

_sources/reference/utils/preprocess_data.rst.txt

@@ -1,20 +1,20 @@
-``t_res.utils.preprocess_data`` module
+``utils.preprocess_data`` module
 ================================
 
-.. automodule:: t_res.utils.preprocess_data
+.. automodule:: utils.preprocess_data
 
-.. autofunction:: t_res.utils.preprocess_data.turn_wikipedia2wikidata
+.. autofunction:: utils.preprocess_data.turn_wikipedia2wikidata
 
-.. autofunction:: t_res.utils.preprocess_data.reconstruct_sentences
+.. autofunction:: utils.preprocess_data.reconstruct_sentences
 
-.. autofunction:: t_res.utils.preprocess_data.process_lwm_for_ner
+.. autofunction:: utils.preprocess_data.process_lwm_for_ner
 
-.. autofunction:: t_res.utils.preprocess_data.process_lwm_for_linking
+.. autofunction:: utils.preprocess_data.process_lwm_for_linking
 
-.. autofunction:: t_res.utils.preprocess_data.aggregate_hipe_entities
+.. autofunction:: utils.preprocess_data.aggregate_hipe_entities
 
-.. autofunction:: t_res.utils.preprocess_data.process_hipe_for_linking
+.. autofunction:: utils.preprocess_data.process_hipe_for_linking
 
-.. autofunction:: t_res.utils.preprocess_data.process_tsv
+.. autofunction:: utils.preprocess_data.process_tsv
 
-.. autofunction:: t_res.utils.preprocess_data.fine_to_coarse
+.. autofunction:: utils.preprocess_data.fine_to_coarse

_sources/reference/utils/process_data.rst.txt

@@ -1,20 +1,20 @@
-``t_res.utils.process_data`` module
+``utils.process_data`` module
 =============================
 
-.. autofunction:: t_res.utils.process_data.eval_with_exception
+.. autofunction:: utils.process_data.eval_with_exception
 
-.. autofunction:: t_res.utils.process_data.prepare_sents
+.. autofunction:: utils.process_data.prepare_sents
 
-.. autofunction:: t_res.utils.process_data.align_gold
+.. autofunction:: utils.process_data.align_gold
 
-.. autofunction:: t_res.utils.process_data.postprocess_predictions
+.. autofunction:: utils.process_data.postprocess_predictions
 
-.. autofunction:: t_res.utils.process_data.ner_and_process
+.. autofunction:: utils.process_data.ner_and_process
 
-.. autofunction:: t_res.utils.process_data.update_with_linking
+.. autofunction:: utils.process_data.update_with_linking
 
-.. autofunction:: t_res.utils.process_data.update_with_skyline
+.. autofunction:: utils.process_data.update_with_skyline
 
-.. autofunction:: t_res.utils.process_data.prepare_storing_links
+.. autofunction:: utils.process_data.prepare_storing_links
 
-.. autofunction:: t_res.utils.process_data.store_for_scorer
+.. autofunction:: utils.process_data.store_for_scorer

_sources/reference/utils/process_wikipedia.rst.txt

@@ -1,8 +1,8 @@
-``t_res.utils.process_wikipedia`` module
+``utils.process_wikipedia`` module
 ==================================
 
-.. autofunction:: t_res.utils.process_wikipedia.make_wikilinks_consistent
+.. autofunction:: utils.process_wikipedia.make_wikilinks_consistent
 
-.. autofunction:: t_res.utils.process_wikipedia.make_wikipedia2wikidata_consisent
+.. autofunction:: utils.process_wikipedia.make_wikipedia2wikidata_consisent
 
-.. autofunction:: t_res.utils.process_wikipedia.title_to_id
+.. autofunction:: utils.process_wikipedia.title_to_id

_sources/reference/utils/rel/entity_disambiguation.rst.txt

@@ -1,8 +1,8 @@
-``t_res.utils.REL.entity_disambiguation`` module
+``utils.REL.entity_disambiguation`` module
 ==========================================
 
-.. autoclass:: t_res.utils.REL.entity_disambiguation.EntityDisambiguation
+.. autoclass:: utils.REL.entity_disambiguation.EntityDisambiguation
     :members:
     :undoc-members:
 
-.. autoattribute:: t_res.utils.REL.entity_disambiguation.RANDOM_SEED
+.. autoattribute:: utils.REL.entity_disambiguation.RANDOM_SEED

_sources/reference/utils/rel/mulrel_ranker.rst.txt

@@ -1,10 +1,10 @@
-``t_res.utils.REL.mulrel_ranker`` module
+``utils.REL.mulrel_ranker`` module
 ==================================
 
-.. autoclass:: t_res.utils.REL.mulrel_ranker.PreRank
+.. autoclass:: utils.REL.mulrel_ranker.PreRank
     :members:
     :undoc-members:
 
-.. autoclass:: t_res.utils.REL.mulrel_ranker.MulRelRanker
+.. autoclass:: utils.REL.mulrel_ranker.MulRelRanker
     :members:
     :undoc-members:

_sources/reference/utils/rel/utils.rst.txt

@@ -1,10 +1,10 @@
-``t_res.utils.REL.t_res.utils`` module
+``utils.REL.utils`` module
 ==========================
 
-.. autofunction:: t_res.utils.REL.t_res.utils.flatten_list_of_lists
+.. autofunction:: utils.REL.utils.flatten_list_of_lists
 
-.. autofunction:: t_res.utils.REL.t_res.utils.make_equal_len
+.. autofunction:: utils.REL.utils.make_equal_len
 
-.. autofunction:: t_res.utils.REL.t_res.utils.is_important_word
+.. autofunction:: utils.REL.utils.is_important_word
 
-.. autoattribute:: t_res.utils.REL.t_res.utils.STOPWORDS
+.. autoattribute:: utils.REL.utils.STOPWORDS

_sources/reference/utils/rel/vocabulary.rst.txt

@@ -1,6 +1,6 @@
-``t_res.utils.REL.vocabulary`` module
+``utils.REL.vocabulary`` module
 ===============================
 
-.. autoclass:: t_res.utils.REL.vocabulary.Vocabulary
+.. autoclass:: utils.REL.vocabulary.Vocabulary
     :members:
     :undoc-members:

_sources/reference/utils/rel_e2e.rst.txt

@@ -1,16 +1,16 @@
-``t_res.utils.rel_e2e`` module
+``utils.rel_e2e`` module
 ========================
 
-.. autofunction:: t_res.utils.rel_e2e.rel_end_to_end
+.. autofunction:: utils.rel_e2e.rel_end_to_end
 
-.. autofunction:: t_res.utils.rel_e2e.get_rel_from_api
+.. autofunction:: utils.rel_e2e.get_rel_from_api
 
-.. autofunction:: t_res.utils.rel_e2e.match_wikipedia_to_wikidata
+.. autofunction:: utils.rel_e2e.match_wikipedia_to_wikidata
 
-.. autofunction:: t_res.utils.rel_e2e.match_ent
+.. autofunction:: utils.rel_e2e.match_ent
 
-.. autofunction:: t_res.utils.rel_e2e.postprocess_rel
+.. autofunction:: utils.rel_e2e.postprocess_rel
 
-.. autofunction:: t_res.utils.rel_e2e.store_rel
+.. autofunction:: utils.rel_e2e.store_rel
 
-.. autofunction:: t_res.utils.rel_e2e.run_rel_experiments
+.. autofunction:: utils.rel_e2e.run_rel_experiments

_sources/reference/utils/rel_utils.rst.txt

@@ -1,14 +1,14 @@
-``t_res.utils.rel_utils`` module
+``utils.rel_utils`` module
 ==========================
 
-.. autofunction:: t_res.utils.rel_utils.get_db_emb
+.. autofunction:: utils.rel_utils.get_db_emb
 
-.. autofunction:: t_res.utils.rel_utils.eval_with_exception
+.. autofunction:: utils.rel_utils.eval_with_exception
 
-.. autofunction:: t_res.utils.rel_utils.prepare_initial_data
+.. autofunction:: utils.rel_utils.prepare_initial_data
 
-.. autofunction:: t_res.utils.rel_utils.rank_candidates
+.. autofunction:: utils.rel_utils.rank_candidates
 
-.. autofunction:: t_res.utils.rel_utils.add_publication
+.. autofunction:: utils.rel_utils.add_publication
 
-.. autofunction:: t_res.utils.rel_utils.prepare_rel_trainset
+.. autofunction:: utils.rel_utils.prepare_rel_trainset