├── .gitignore
├── LICENSE
├── README.md
├── pom.xml
└── src
    ├── main
        └── java
        │   └── com
        │       └── guokr
        │           └── nlp
        │               ├── GkNlpCli.java
        │               └── __PKG__.java
    └── test
        └── java
            └── com
                └── guokr
                    └── nlp
                        └── test
                            └── BasicTests.java


/.gitignore:
--------------------------------------------------------------------------------
 1 | *jar
 2 | /target/
 3 | .lein-deps-sum
 4 | .lein-failures
 5 | 
 6 | dependency-reduced-pom.xml
 7 | 
 8 | # OS generated files #
 9 | .DS_Store
10 | .DS_Store?
11 | ._*
12 | .Spotlight-V100
13 | .Trashes
14 | Icon?
15 | ehthumbs.db
16 | Thumbs.db
17 | 
18 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | stan-cn-nlp
 2 | ============
 3 | 
 4 | An API wrapper based on Stanford NLP packages for Simplified Chinese users
 5 | 
 6 | * * * * * * *
 7 | 
 8 | Copyright (C) 2012  Guokr.com
 9 | 
10 | This program is free software; you can redistribute it and/or
11 | modify it under the terms of the GNU General Public License
12 | as published by the Free Software Foundation; either version 2
13 | of the License, or (at your option) any later version.
14 | 
15 | This program is distributed in the hope that it will be useful,
16 | but WITHOUT ANY WARRANTY; without even the implied warranty of
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 | GNU General Public License for more details.
19 | 
20 | You should have received a copy of the GNU General Public License
21 | along with this program; if not, write to the Free Software
22 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
23 | 
24 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | stan-cn-nlp
  2 | ============
  3 | 
  4 | An API wrapper based on Stanford NLP packages for the convenience of Chinese
  5 | users. This package is based on stan-cn-* family:
  6 | 
  7 | * stan-cn-com: Common code base
  8 | * stan-cn-seg: Chinese segmentation and related data model
  9 | * stan-cn-ner: Named entity recognition and related data model
 10 | * stan-cn-tag: POS tagging and related data model
 11 | 
 12 | This package bundled seg, ner and tagging together. So if you only need one of
 13 | them, you can use stan-cn-seg, stan-cn-ner, stan-cn-tag separately.
 14 | 
 15 | Purpose of the packages
 16 | ------------------------
 17 | 
 18 | The original Stanford CoreNLP packages with default language settings in Maven
 19 | central is only for English. If you are dealing with simplified Chinese, you
 20 | still need to download the Chinese model and fix some configuration files.
 21 | 
 22 | The burden is not too much, but if you deploy these packages to a server
 23 | cluster, this burden might be amplified.
 24 | 
 25 | Whatever you face a single node or a server farm, it would be a pleasurable
 26 | solution to provide packages with default settings of Chinese language
 27 | models. That is what we do.
 28 | 
 29 | Comments, reviews, bug reports and patches are welcomed.
 30 | 
 31 | Current version
 32 | ----------------
 33 | 
 34 | Current version is 0.0.4 and based on Stanford CoreNLP 3.2.0 with minor fixes.
 35 | 
 36 | including below dependency:
 37 | 
 38 | * maven:
 39 | ```xml
 40 |     <dependency>
 41 |         <groupId>com.guokr</groupId>
 42 |         <artifactId>stan-cn-nlp</artifactId>
 43 |         <version>0.0.4</version>
 44 |     </dependency>
 45 | ```
 46 | * leiningen:
 47 | ```clojure
 48 |     [com.guokr/stan-cn-nlp "0.0.4"]
 49 | ```
 50 | * sbt:
 51 | ```scala
 52 |     libraryDependencies += "com.guokr" % "stan-cn-nlp" % "0.0.4"
 53 | ```
 54 | 
 55 | Simplified API
 56 | ---------------
 57 | 
 58 | We use a very simple API to reduce the complexity.
 59 | 
 60 | ```java
 61 |     new SegWrapper(settings).segment(text);
 62 |     new NerWrapper(settings).recognize(text);
 63 |     new TagWrapper(settings).tag(text);
 64 | ```
 65 | 
 66 | Or if you want to use the default language models, just use
 67 | 
 68 | ```java
 69 |     __PKG__.INSTANCE.segment(text);
 70 |     __PKG__.INSTANCE.recognize(text);
 71 |     __PKG__.INSTANCE.tag(text);
 72 | ```
 73 | 
 74 | The command line tool
 75 | ----------------------
 76 | 
 77 | Please follow below steps to play with:
 78 | 
 79 | * git clone git://github.com/guokr/stan-cn-nlp.git
 80 | * cd stan-cn-nlp
 81 | * mvn package
 82 | * java -Xms1g -Xmx2g -jar target/stan-cn-nlp-0.0.5-SNAPSHOT-standalone.jar seg "大江东去浪淘尽"
 83 | * java -Xms1g -Xmx2g -jar target/stan-cn-nlp-0.0.5-SNAPSHOT-standalone.jar ner "大江东去浪淘尽"
 84 | * java -Xms1g -Xmx2g -jar target/stan-cn-nlp-0.0.5-SNAPSHOT-standalone.jar tag "大江东去浪淘尽"
 85 | 
 86 | Preparation for release
 87 | ------------------------
 88 | 
 89 | Before release this package to maven central, please execute below commands:
 90 | 
 91 | * mvn clean source:jar javadoc:jar package
 92 | * export MAVEN_OPTS=-Xmx2048m
 93 | * mvn release:clean
 94 | * mvn release:prepare
 95 | * mvn release:perform
 96 | 
 97 | Authors
 98 | --------
 99 | 
100 | * Mingli Yuan ( https://github.com/mountain )
101 | * Rui Wang ( https://github.com/isnowfy )
102 | * Wanjian Wu ( https://github.com/jseagull )
103 | 
104 | License
105 | --------
106 | 
107 | GPLv2, just same as the license of Stanford CoreNLP package
108 | 


--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  3 |   <modelVersion>4.0.0</modelVersion>
  4 |   <groupId>com.guokr</groupId>
  5 |   <artifactId>stan-cn-nlp</artifactId>
  6 |   <version>0.0.5-SNAPSHOT</version>
  7 |   <packaging>jar</packaging>
  8 |   <name>stan-cn-nlp</name>
  9 |   <description>An API wrapper based on Stanford Core NLP package for Simplified Chinese users</description>
 10 |   <url>https://github.com/guokr/stan-cn-nlp</url>
 11 |   <licenses>
 12 |     <license>
 13 |       <name>GNU General Public License Version 2</name>
 14 |       <url>http://www.gnu.org/licenses/gpl-2.0.txt</url>
 15 |     </license>
 16 |   </licenses>
 17 |   <scm>
 18 |     <url>https://github.com/guokr/stan-cn-nlp</url>
 19 |     <connection>scm:git:git://github.com/guokr/stan-cn-nlp.git</connection>
 20 |     <developerConnection>scm:git:ssh://git@github.com/guokr/stan-cn-nlp.git</developerConnection>
 21 |   </scm>
 22 |   <developers>
 23 |     <developer>
 24 |       <id>mingli.yuan</id>
 25 |       <name>Mingli Yuan</name>
 26 |       <email>mingli.yuan@gmail.com</email>
 27 |     </developer>
 28 |     <developer>
 29 |       <id>isnowify</id>
 30 |       <name>Rui Wang</name>
 31 |       <email>isnowfy@gmail.com</email>
 32 |     </developer>
 33 |   </developers>
 34 |   <parent>
 35 |     <groupId>org.sonatype.oss</groupId>
 36 |     <artifactId>oss-parent</artifactId>
 37 |     <version>7</version>
 38 |   </parent>
 39 |   <properties>
 40 |     <maven.compiler.source>1.6</maven.compiler.source>
 41 |     <maven.compiler.target>1.5</maven.compiler.target>
 42 |     <encoding>UTF-8</encoding>
 43 |     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 44 |   </properties>
 45 |   <dependencies>
 46 |     <dependency>
 47 |       <groupId>com.guokr</groupId>
 48 |       <artifactId>stan-cn-com</artifactId>
 49 |       <version>0.0.5-SNAPSHOT</version>
 50 |     </dependency>
 51 |     <dependency>
 52 |       <groupId>com.guokr</groupId>
 53 |       <artifactId>stan-cn-seg</artifactId>
 54 |       <version>0.0.5-SNAPSHOT</version>
 55 |     </dependency>
 56 |     <dependency>
 57 |       <groupId>com.guokr</groupId>
 58 |       <artifactId>stan-cn-ner</artifactId>
 59 |       <version>0.0.5-SNAPSHOT</version>
 60 |     </dependency>
 61 |     <dependency>
 62 |       <groupId>com.guokr</groupId>
 63 |       <artifactId>stan-cn-tag</artifactId>
 64 |       <version>0.0.5-SNAPSHOT</version>
 65 |     </dependency>
 66 |     <dependency>
 67 |       <groupId>junit</groupId>
 68 |       <artifactId>junit</artifactId>
 69 |       <version>4.7</version>
 70 |       <scope>test</scope>
 71 |     </dependency>
 72 |   </dependencies>
 73 |   <build>
 74 |     <sourceDirectory>src/main/java</sourceDirectory>
 75 |     <testSourceDirectory>src/test/java</testSourceDirectory>
 76 |     <resources>
 77 |       <resource>
 78 |         <directory>src/main/resources</directory>
 79 |       </resource>
 80 |     </resources>
 81 |     <testResources>
 82 |       <testResource>
 83 |         <directory>src/main/resources</directory>
 84 |       </testResource>
 85 |     </testResources>
 86 |     <directory>target</directory>
 87 |     <outputDirectory>target/classes</outputDirectory>
 88 |     <plugins>
 89 |       <plugin>
 90 |         <groupId>org.apache.maven.plugins</groupId>
 91 |         <artifactId>maven-compiler-plugin</artifactId>
 92 |         <version>3.0</version>
 93 |         <configuration>
 94 |           <source>1.5</source>
 95 |           <target>1.5</target>
 96 |         </configuration>
 97 |       </plugin>
 98 |       <plugin>
 99 |         <groupId>org.codehaus.mojo</groupId>
100 |         <artifactId>build-helper-maven-plugin</artifactId>
101 |         <version>1.7</version>
102 |         <executions>
103 |           <execution>
104 |             <id>add-source</id>
105 |             <phase>generate-sources</phase>
106 |             <goals>
107 |               <goal>add-source</goal>
108 |             </goals>
109 |             <configuration>
110 |               <sources>
111 |                 <source>src/main/java</source>
112 |               </sources>
113 |             </configuration>
114 |           </execution>
115 |           <execution>
116 |             <id>add-test-source</id>
117 |             <phase>generate-test-sources</phase>
118 |             <goals>
119 |               <goal>add-test-source</goal>
120 |             </goals>
121 |             <configuration>
122 |               <sources>
123 |                 <source>src/test/java</source>
124 |               </sources>
125 |             </configuration>
126 |           </execution>
127 |         </executions>
128 |       </plugin>
129 |       <plugin>
130 |         <groupId>org.apache.maven.plugins</groupId>
131 |         <artifactId>maven-surefire-plugin</artifactId>
132 |         <version>2.12.4</version>
133 |         <dependencies>
134 |           <dependency>
135 |             <groupId>org.apache.maven.surefire</groupId>
136 |             <artifactId>surefire-junit47</artifactId>
137 |             <version>2.12.4</version>
138 |           </dependency>
139 |         </dependencies>
140 |         <configuration>
141 |             <includes>
142 |                 <include>**/*Tests.java</include>
143 |             </includes>
144 |             <forkMode>once</forkMode>
145 |             <argLine>-Xms2g -Xmx2g</argLine>
146 |         </configuration>
147 |       </plugin>
148 |       <plugin>
149 |         <groupId>org.apache.maven.plugins</groupId>
150 |         <artifactId>maven-shade-plugin</artifactId>
151 |         <version>2.0</version>
152 |         <executions>
153 |           <execution>
154 |             <phase>package</phase>
155 |             <goals>
156 |               <goal>shade</goal>
157 |             </goals>
158 |             <configuration>
159 |               <createDependencyReducedPom>false</createDependencyReducedPom>
160 |               <createSourcesJar>true</createSourcesJar>
161 |               <finalName>stan-cn-nlp-${project.version}-standalone</finalName>
162 |               <transformers>
163 |                 <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
164 |                   <manifestEntries>
165 |                     <Main-Class>com.guokr.nlp.GkNlpCli</Main-Class>
166 |                     <Build-Number>1</Build-Number>
167 |                   </manifestEntries>
168 |                 </transformer>
169 |               </transformers>
170 |             </configuration>
171 |           </execution>
172 |         </executions>
173 |       </plugin>
174 |     </plugins>
175 |   </build>
176 | </project>
177 | 


--------------------------------------------------------------------------------
/src/main/java/com/guokr/nlp/GkNlpCli.java:
--------------------------------------------------------------------------------
 1 | package com.guokr.nlp;
 2 | 
 3 | import java.lang.reflect.Method;
 4 | import java.io.PrintStream;
 5 | 
 6 | public class GkNlpCli {
 7 | 
 8 |     public static void main(String[] args) {
 9 |         __PKG__ pkg = __PKG__.INSTANCE;
10 |         if(args.length < 2) {
11 |             usage();
12 |         } else {
13 |             String subcmd = args[0];
14 |             String text = args[1];
15 |             if(subcmd.equals("seg")) {
16 |                 try {
17 |                     String segText = pkg.segment(text);
18 |                     System.out.println(segText);
19 |                 } catch (Exception e) {
20 |                     System.out.println(e);
21 |                     e.printStackTrace(System.err);
22 |                 }
23 |             } else if(subcmd.equals("ner")) {
24 |                 try {
25 |                     String nerText = pkg.recognize(text);
26 |                     System.out.println(nerText);
27 |                 } catch (Exception e) {
28 |                     System.out.println(e);
29 |                     e.printStackTrace(System.err);
30 |                 }
31 |             } else if(subcmd.equals("tag")) {
32 |                 try {
33 |                     String tagText = pkg.tag(text);
34 |                     System.out.println(tagText);
35 |                 } catch (Exception e) {
36 |                     System.out.println(e);
37 |                     e.printStackTrace(System.err);
38 |                 }
39 |             }
40 |         }
41 | 
42 |     }
43 | 
44 |     private static void usage() {
45 |         PrintStream out = System.out;
46 |         out.println("gknlp [command] [text]");
47 |         out.println("\tcommands:");
48 |         out.println("\t\tseg: segment the text into words");
49 |         out.println("\t\tner: recognize the named entity in the text");
50 |         out.println("\t\ttag: tag the text into words with syntax information");
51 |         out.println("");
52 |     }
53 | 
54 | }
55 | 


--------------------------------------------------------------------------------
/src/main/java/com/guokr/nlp/__PKG__.java:
--------------------------------------------------------------------------------
 1 | package com.guokr.nlp;
 2 | 
 3 | public enum __PKG__ {
 4 | 
 5 |     INSTANCE;
 6 | 
 7 |     public String segment(String text) {
 8 |         return com.guokr.nlp.seg.__SEG__.INSTANCE.segment(text);
 9 |     }
10 | 
11 |     public String recognize(String text) {
12 |         return com.guokr.nlp.ner.__NER__.INSTANCE.recognize(text);
13 |     }
14 | 
15 |     public String tag(String text) {
16 |         return com.guokr.nlp.tag.__TAG__.INSTANCE.tag(text);
17 |     }
18 | 
19 | }
20 | 
21 | 


--------------------------------------------------------------------------------
/src/test/java/com/guokr/nlp/test/BasicTests.java:
--------------------------------------------------------------------------------
 1 | package com.guokr.nlp.test;
 2 | 
 3 | import java.lang.reflect.Method;
 4 | 
 5 | import static org.junit.Assert.assertEquals;
 6 | 
 7 | import org.junit.Test;
 8 | import org.junit.runner.RunWith;
 9 | import org.junit.runners.JUnit4;
10 | 
11 | import com.guokr.nlp.__PKG__;
12 | 
13 | @RunWith(JUnit4.class)
14 | public class BasicTests {
15 | 
16 |     @Test
17 |     public void testSeg() throws Exception {
18 |         String segText = __PKG__.INSTANCE.segment("这是个测试");
19 |         assertEquals("这 是 个 测试", segText);
20 |     }
21 | 
22 |     @Test
23 |     public void testNer() throws Exception {
24 |         String nerText = __PKG__.INSTANCE.recognize("这是个测试");
25 |         assertEquals("这/O 是/O 个/O 测试/O", nerText);
26 |     }
27 | 
28 |     @Test
29 |     public void testTag() throws Exception {
30 |         String tagText = __PKG__.INSTANCE.tag("这是个测试");
31 |         assertEquals("这#PN 是#VC 个#M 测试#NN", tagText);
32 |     }
33 | 
34 | }
35 | 


--------------------------------------------------------------------------------