|
1 | 1 | # NLPPlus
|
2 | 2 |
|
| 3 | +The NLPPlus Python Package is the package that allows for python scripts |
| 4 | +to call text and NLP analyzers created using [NLP++](https://visualtext.org). The package uses |
| 5 | +the C++ libraries for the [NLP Engine](https://github.com/VisualText/nlp-engine) making the calling more efficient than |
| 6 | +using the [NLP++ python class](https://github.com/VisualText/python) that calls command line version of the NLP |
| 7 | +Engine "nlp.exe". |
| 8 | + |
| 9 | +The major advantage of NLPPlus over other NLP packages is that is 100% |
| 10 | +rule-based and modifiable and allows for any non-linguistic programmer |
| 11 | +to create text analyzers 100% taylored to their needs. |
| 12 | + |
| 13 | +## Long-Term Open-Source, Glass-Box Project |
| 14 | + |
| 15 | +NLP++ allows any programmer to write text and NLP programs that can be |
| 16 | +shared by everyone. It represents the first universal programming |
| 17 | +language for text and NLP. [As the community grows](https://nluglog.org), the number of open-source |
| 18 | +solutions including dictionaries, knowledge bases, and analyzers will |
| 19 | +grow - all of which can be modified by any programmer using the NLP++ |
| 20 | +Language Extension for VSCode. |
| 21 | + |
3 | 22 | ## READ FIRST
|
4 | 23 |
|
5 |
| -It is important to understand that the NLPPlus package for Python is very different from ALL other NLP packages |
6 |
| -in a very important and practical way. |
| 24 | +It is important to understand that the NLPPlus package for Python is very |
| 25 | +different from ALL other NLP packages in a very important and practical way. |
7 | 26 |
|
8 | 27 | Current NLP python packages have the "intention" of being plug-and-play
|
9 | 28 | systems that perform natural language tasks without modification. The
|
@@ -51,16 +70,15 @@ around the world are starting to use NLP++ to write human digital readers for
|
51 | 70 |
|
52 | 71 | ## <span style='color:orange'>Installation</span>
|
53 | 72 |
|
54 |
| -### Future Installation (waiting for approval) |
| 73 | +### Installation |
55 | 74 |
|
56 |
| -NLPPlus should eventually be installable from PyPI using pip, at which |
57 |
| -point you can simply run: |
| 75 | +NLPPlus can be installed using pip: |
58 | 76 |
|
59 | 77 | pip install nlpplus
|
60 | 78 |
|
61 |
| -### Installing By Downloading the Package (currently the only method) |
| 79 | +### Installing By Downloading the Package Manually |
62 | 80 |
|
63 |
| -For the moment, you can find the installable "wheel" files under each |
| 81 | +You can find the installable "wheel" files under each |
64 | 82 | release in the [Releases
|
65 | 83 | page](https://github.com/VisualText/py-package-nlpengine/releases/).
|
66 | 84 | Choose the correct version for your platform and Python version based
|
@@ -166,6 +184,8 @@ or JSON output from them:
|
166 | 184 |
|
167 | 185 | ### NLPPlus Engine Functions
|
168 | 186 |
|
| 187 | +These are the current functions that come with the NLPPlus package. |
| 188 | + |
169 | 189 | #### set_analyzer_folder(analyzer_folder_path: str)
|
170 | 190 | This is used to set the folder where your analyzers are located.
|
171 | 191 |
|
|
0 commit comments