Add Dacoref to the library documentation

alexandrainst · Nov 23, 2020 · 069e1fb · 069e1fb
1 parent 5dd0e63
commit 069e1fb
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 6 deletions.
diff --git a/danlp/datasets/dacoref.py b/danlp/datasets/dacoref.py
@@ -6,7 +6,14 @@
 
 class Dacoref:
     """
-    This Danish coreference annotation contains parts of the Copenhagen Dependency Treebank, It was originally annotatated as part of the Copenhagen Dependency Treebank (CDT) project but never finished. This resource extens the annotation by using different mapping techniques and by augmenting with Qcodes from Wiktionary. Read more about it in the danlp docs.
+    This Danish coreference annotation contains parts of the Copenhagen Dependency Treebank. 
+    It was originally annotated as part of the Copenhagen Dependency Treebank (CDT) project but never finished. 
+    This resource extends the annotation by using different mapping techniques and by augmenting with Qcodes from Wiktionary. 
+    Read more about it in the danlp docs.
+
+    :param str cache_dir: the directory for storing cached models
+    :param bool verbose: `True` to increase verbosity
+
     """
 
     def __init__(self, cache_dir: str = DEFAULT_CACHE_DIR):
@@ -15,8 +22,8 @@ def __init__(self, cache_dir: str = DEFAULT_CACHE_DIR):
 
     def load_as_conllu(self, predefined_splits: bool = False):
         """
-        :param predefined_splits: Boolean
-        :return A single parsed conllu list
+        :param bool predefined_splits: Boolean
+        :return: A single parsed conllu list
                 or a list of train, dev, test split parsed conllu list
                 depending on predefined_split
         """

diff --git a/docs/docs/datasets.md b/docs/docs/datasets.md
@@ -49,9 +49,9 @@ The dataset can also be downloaded directly in CoNLL-U format.
 
 ### Dacoref
 
-This Danish coreference annotation contains parts of the Copenhagen Dependency Treebank  (Kromann and Lynge (2004), It was originally annotated as part of the Copenhagen Dependency Treebank (CDT) project but never finished. This resource extends the annotation by using different mapping techniques and by augmenting with Qcodes from Wiktionary. This works is conducted by Maria Jung Barrett. Read more about it in the  in the dedicated [dacoref docs](https://github.com/alexandrainst/danlp/master/docs/docs/dacoref_docs.md).
+This Danish coreference annotation contains parts of the Copenhagen Dependency Treebank  (Kromann and Lynge, 2004), It was originally annotated as part of the Copenhagen Dependency Treebank (CDT) project but never finished. This resource extends the annotation by using different mapping techniques and by augmenting with Qcodes from Wiktionary. This work is conducted by Maria Jung Barrett. Read more about it in the dedicated [dacoref docs](dacoref_docs.md).
 
-The dataset can be load with the DaNLP package:
+The dataset can be loaded with the DaNLP package:
 
 ```python
 from danlp.datasets import Dacoref
@@ -60,7 +60,7 @@ dacoref = Dacoref()
 corpus = dacoref.load_as_conllu(predefined_splits=True) 
 ```
 
-The dataset can also be download directly:
+The dataset can also be downloaded directly:
 
 [Download dacoref](http://danlp-downloads.alexandra.dk/datasets/dacoref.zip) 
 

diff --git a/docs/library/datasets.rst b/docs/library/datasets.rst
@@ -9,6 +9,14 @@ Danish Dependency Treebank
     :show-inheritance:
 
 
+Dacoref
+--------------------------
+
+.. automodule:: danlp.datasets.dacoref
+    :members:
+    :show-inheritance:
+
+
 Sentiment datasets
 ------------------