Improve/documentation (#67)

* 📝 Added Relations extractor docs. Signed-off-by: Marcos Martinez <[email protected]> * 📝 Added Relations extractor docs. Signed-off-by: Marcos Martinez <[email protected]> --------- Signed-off-by: Marcos Martinez <[email protected]>
IBM · Sep 5, 2023 · c081a77 · c081a77
1 parent 127cfae
commit c081a77
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -99,12 +99,23 @@ Again, there are 4 **linkers** available currently, 2 of them are *end-to-end* a
 |     SMXM    |   &check;  | [Source Code](https://github.com/Raldir/Zero-shot-NERC)  | [Paper](https://aclanthology.org/2021.acl-long.120/)               |
 |     TARS    |   &check;  | [Source Code](https://github.com/flairNLP/flair)         | [Paper](https://kishaloyhalder.github.io/pdfs/tars_coling2020.pdf) |
 
+### Relations Extractor
+The **relations extractor** will extract relations among different entities *previously* extracted by a **linker**.. 
+
+Currently, the is only one Relation Extractor available: 
+
+- ZS-Bert
+  - [Paper](https://arxiv.org/abs/2104.04697)
+  - [Source Code](https://github.com/dinobby/ZS-BERT)
+
 
 ### Knowledge Extractor
 The **knowledge extractor** will perform at the same time the extraction and classification of named entities and the extraction of relations among them. The pipeline with this component doesn't need any **mentions extractor**, **linker** or **relation extractor** to work.
 
 Currently, the is only one Knowledge Extractor available: 
+
 - KnowGL
+
   - [Rossiello et al. (AAAI 2023)](https://arxiv.org/pdf/2210.13952.pdf)
   - [Mihindukulasooriya et al. (ISWC 2022)](https://arxiv.org/pdf/2207.05188.pdf)
 

diff --git a/docs/relation_extractor.md b/docs/relation_extractor.md
@@ -0,0 +1,8 @@
+# Relations Extractor
+
+The **relations extractor** will extract relations among different entities *previously* extracted by a **linker**.. 
+
+Currently, the is only one Relation Extractor available: ZS-Bert
+
+
+::: zshot.RelationsExtractor
diff --git a/docs/zsbert_relations_extractor.md b/docs/zsbert_relations_extractor.md
@@ -0,0 +1,10 @@
+# ZS-BERT Relations Extractor
+
+The ZS-BERT model is a novel multi-task learning model to directly predict unseen relations without hand-crafted attribute labeling and multiple pairwise classifications. Given training instances consisting of input sentences and the descriptions of their relations, ZS-BERT learns two functions that project sentences and relation descriptions into an embedding space by jointly minimizing the distances between them and classifying seen relations. By generating the embeddings of unseen relations and new-coming sentences based on such two functions, we use nearest neighbor search to obtain the prediction of unseen relations.
+
+This `RelationsExtractor` uses relations pre-defined along with their descriptions, added into the `PipelineConfig` using the `Relation` data model.
+
+- [Paper](https://arxiv.org/abs/2104.04697)
+- [Original Repo](https://github.com/dinobby/ZS-BERT)
+
+::: zshot.relations_extractor.RelationsExtractorZSRC
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -21,6 +21,12 @@ nav:
     - regen.md
     - smxm_linker.md
     - tars_linker.md
+  - Relations Extractor:
+      - relations_extractor.md
+      - zsbert_relations_extractor.md
+  - Knowledge Extractor:
+      - knowledge_extractor.md
+      - knowgl_knowledge_extractor.md
 
 markdown_extensions:
   - attr_list