Change constituency parser's abbrivation.

Author: emfomy

ckipnlp/container/parse.py

@@ -2,7 +2,7 @@
 # -*- coding:utf-8 -*-
 
 """
-This module provides containers for parse sentences.
+This module provides containers for parsed sentences.
 """
 
 __author__ = 'Mu Yang <http://muyang.pro>'

ckipnlp/container/util/parse_tree.py

@@ -2,7 +2,7 @@
 # -*- coding:utf-8 -*-
 
 """
-This module provides tree containers for sentence parse.
+This module provides tree containers for parsed sentences.
 """
 
 __author__ = 'Mu Yang <http://muyang.pro>'

ckipnlp/driver/__init__.py

@@ -17,7 +17,7 @@
 
 from .classic import (
     CkipClassicWordSegmenter,
-    CkipClassicConstituencyParser,
+    CkipClassicConParser,
 )
 
 from .ss import (

ckipnlp/driver/classic.py

@@ -130,8 +130,8 @@ def _call(self, *, _wspos):
 
 ################################################################################################################################
 
-class CkipClassicConstituencyParser(_BaseDriver):
-    """The CKIP sentence parsing driver with CkipClassic backend.
+class CkipClassicConParser(_BaseDriver):
+    """The CKIP constituency parsing driver with CkipClassic backend.
 
     Arguments
     ---------
@@ -140,7 +140,7 @@ class CkipClassicConstituencyParser(_BaseDriver):
 
     .. method:: __call__(*, ws, pos)
 
-        Apply sentence parsing.
+        Apply constituency parsing.
 
         Parameters
             - **ws** (:class:`~ckipnlp.container.text.TextParagraph`) — The word-segmented sentences.
@@ -150,7 +150,7 @@ class CkipClassicConstituencyParser(_BaseDriver):
             **conparse** (:class:`~ckipnlp.container.parse.ParseSentence`) — The constituency-parsing sentences.
     """
 
-    driver_type = 'constituency_parser'
+    driver_type = 'con_parser'
     driver_family = 'classic'
     driver_inputs = ('ws', 'pos',)
 

ckipnlp/pipeline/coref.py

@@ -74,8 +74,8 @@ class CkipCorefPipeline(_CkipPipeline):
         ner_chunker : str
             The type of named-entity recognition chunker.
 
-        constituency_parser : str
-            The type of sentence parser.
+        con_parser : str
+            The type of constituency parser.
 
         coref_chunker : str
             The type of coreference resolution chunker.

ckipnlp/pipeline/kernel.py

@@ -78,8 +78,8 @@ class CkipPipeline:
         ner_chunker : str
             The type of named-entity recognition chunker.
 
-        constituency_parser : str
-            The type of sentence parser.
+        con_parser : str
+            The type of constituency parser.
 
     Other Parameters
     ----------------
@@ -94,7 +94,7 @@ def __init__(self, *,
             sentence_segmenter='default',
             word_segmenter='tagger',
             pos_tagger='tagger',
-            constituency_parser='classic',
+            con_parser='classic',
             ner_chunker='tagger',
             lazy=True,
             opts={},
@@ -125,8 +125,8 @@ def __init__(self, *,
         self._pos_tagger = _DriverRegister.get('pos_tagger', pos_tagger)(
             lazy=lazy, **opts.get('pos_tagger', {}),
         )
-        self._constituency_parser = _DriverRegister.get('constituency_parser', constituency_parser)(
-            lazy=lazy, **opts.get('constituency_parser', {}),
+        self._con_parser = _DriverRegister.get('con_parser', con_parser)(
+            lazy=lazy, **opts.get('con_parser', {}),
         )
         self._ner_chunker = _DriverRegister.get('ner_tagger', ner_chunker)(
             lazy=lazy, **opts.get('ner_chunker', {}),
@@ -152,7 +152,7 @@ def _get(self, key, doc):
                 self._pos_tagger, 'part-of-speech tagging',
             ),
             'conparse': (
-                self._constituency_parser, 'constituency parsing',
+                self._con_parser, 'constituency parsing',
             ),
             'ner': (
                 self._ner_chunker, 'named-entity recognition',

docs/main/_defn.rst

@@ -12,7 +12,7 @@
 .. Driver
 
 .. |CkipClassicWordSegmenter| replace:: :class:`~ckipnlp.driver.classic.CkipClassicWordSegmenter`
-.. |CkipClassicConstituencyParser| replace:: :class:`~ckipnlp.driver.classic.CkipClassicConstituencyParser`
+.. |CkipClassicConParser| replace:: :class:`~ckipnlp.driver.classic.CkipClassicConParser`
 
 .. |CkipTaggerWordSegmenter| replace:: :class:`~ckipnlp.driver.tagger.CkipTaggerWordSegmenter`
 .. |CkipTaggerPosTagger| replace:: :class:`~ckipnlp.driver.tagger.CkipTaggerPosTagger`

docs/main/usage/driver.rst

@@ -42,7 +42,7 @@ Sentence Segmenter                |CkipSentenceSegmenter|
 Word Segmenter                                                      |CkipTaggerWordSegmenter|         |CkipClassicWordSegmenter|†
 Pos Tagger                                                          |CkipTaggerPosTagger|             |CkipClassicWordSegmenter|†
 Ner Chunker                                                         |CkipTaggerNerChunker|
-Constituency Parser                                                                                    |CkipClassicConstituencyParser|
+Constituency Parser                                                                                   |CkipClassicConParser|
 Coref Chunker                     |CkipCorefChunker|
 ================================  ================================  ================================  ================================
 

test/script/pipeline/run_classic_constituency_parser.py renamed to test/script/pipeline/run_classic_con_parser.py

@@ -7,8 +7,8 @@
 
 from _base import *
 
-def test_classic_constituency_parser():
-    obj = CkipPipeline(constituency_parser='classic')
+def test_classic_con_parser():
+    obj = CkipPipeline(con_parser='classic')
     doc = CkipDocument(ws=SegParagraph.from_list(ws), pos=SegParagraph.from_list(pos))
     obj.get_conparse(doc)
     assert doc.conparse.to_list() == conparse

test/tox.ini

@@ -82,4 +82,4 @@ commands_pre =
 commands =
 	pytest {toxinidir}/script/pipeline/run_classic_word_segmenter.py {env:NO_COV:--cov=ckipnlp.pipeline --cov=ckipnlp.driver} {posargs}
 	pytest {toxinidir}/script/pipeline/run_classic_word_segmenter_pos_tagger.py {env:NO_COV:--cov=ckipnlp.pipeline --cov=ckipnlp.driver} {posargs}
-	pytest {toxinidir}/script/pipeline/run_classic_constituency_parser.py {env:NO_COV:--cov=ckipnlp.pipeline --cov=ckipnlp.driver} {posargs}
+	pytest {toxinidir}/script/pipeline/run_classic_con_parser.py {env:NO_COV:--cov=ckipnlp.pipeline --cov=ckipnlp.driver} {posargs}