mirror of
https://github.com/yanyiwu/cppjieba.git
synced 2025-07-18 00:00:12 +08:00
modify README.md
This commit is contained in:
wyy
parent
b0c2bf6490
commit
2f22c5507c
133
README.md
133
README.md
@ -7,41 +7,63 @@
|
||||
- `master`分支支持`utf8`编码
|
||||
- `gbk`分支支持`gbk`编码
|
||||
|
||||
## 安装与使用
|
||||
|
||||
## 模块详解
|
||||
### 下载和安装
|
||||
|
||||
### Trie树
|
||||
Trie.cpp/Trie.h 负责载入词典的trie树，主要供Segment模块使用。
|
||||
```sh
|
||||
wget https://github.com/aszxqw/cppjieba/archive/master.zip -O cppjieba-master.zip
|
||||
unzip cppjieba-master.zip
|
||||
cd cppjieba-master
|
||||
mkdir build
|
||||
cd build
|
||||
cmake -DCMAKE_INSTALL_PREFIX=/usr ..
|
||||
make
|
||||
sudo make install
|
||||
```
|
||||
|
||||
### Segment模块
|
||||
### 卸载
|
||||
```sh
|
||||
cd build/
|
||||
cat install_manifest.txt | sudo xargs rm -rf
|
||||
```
|
||||
|
||||
MPSegment.cpp/MPSegment.h
|
||||
(Maximum Probability)最大概率法:负责根据Trie树构建有向无环图和进行动态规划算法，是分词算法的核心。
|
||||
### 验证
|
||||
|
||||
HMMSegment.cpp/HMMSegment.h
|
||||
是根据HMM模型来进行分词，主要算法思路是根据(B,E,M,S)四个状态来代表每个字的隐藏状态。
|
||||
HMM模型由dicts/下面的`hmm_model.utf8`提供。
|
||||
分词算法即viterbi算法。
|
||||
```sh
|
||||
cd test/
|
||||
g++ -o segment.demo segment.cpp -L/usr/lib/CppJieba/ -lcppjieba
|
||||
./segment # you will see the demo.
|
||||
```
|
||||
|
||||
运行一下 `./server` 或 `./segment` 都会有对应的帮助文档显示。
|
||||
|
||||
### TransCode模块
|
||||
同时，如果想知道开发时如何使用`libcppjieba.a` 请看`test/segment.cpp`源代码即可。
|
||||
|
||||
TransCode.cpp/TransCode.h 负责转换编码类型，将utf8和gbk转换成`uint16_t`类型，也负责逆转换。
|
||||
如果想知道如何搭建一个`cppjieba`中文分词的http服务请见 `test/server.cpp`源代码即可。
|
||||
|
||||
若还有其他问题，欢迎`send mail`或者`open issue`。 :)
|
||||
|
||||
### 搭建服务
|
||||
|
||||
## Demo
|
||||
```
|
||||
cd ./test
|
||||
g++ -o server server.cpp -L/usr/lib/CppJieba/ -L/usr/lib/CppJieba/Husky -lcppjieba -lhusky -lpthread
|
||||
./server -n 4 -p 11258 -k start #启动服务，监听11258这个端口。
|
||||
./server -n 4 -p 11258 -k stop #停止服务
|
||||
```
|
||||
|
||||
#### 验证服务
|
||||
|
||||
然后用chrome浏览器打开`http://127.0.0.1:11258/?key=我来自北京邮电大学`
|
||||
(用chrome的原因是chrome的默认编码就是utf-8)
|
||||
|
||||
或者用命令 `curl "http://127.0.0.1:11258/?key=我来自北京邮电大学"` (ubuntu中的curl安装命令`sudo apt-get install curl`)
|
||||
|
||||
## 分词效果
|
||||
|
||||
### MPSegment's demo
|
||||
|
||||
__这部分的功能经过线上考验，一直稳定运行，暂时没有发现什么bug。__
|
||||
|
||||
```
|
||||
cd ./demo;
|
||||
make;
|
||||
./segment_demo testlines.utf8
|
||||
```
|
||||
|
||||
Output:
|
||||
```
|
||||
我来到北京清华大学
|
||||
@ -59,12 +81,6 @@ Output:
|
||||
|
||||
### HMMSegment's demo
|
||||
|
||||
```
|
||||
cd ./demo;
|
||||
make;
|
||||
./segment_demo testlines.utf8 --modelpath ../dicts/hmm_model.utf8 --algorithm cutHMM
|
||||
```
|
||||
|
||||
Output:
|
||||
```
|
||||
我来到北京清华大学
|
||||
@ -78,11 +94,6 @@ Output:
|
||||
```
|
||||
|
||||
### MixSegment's demo
|
||||
```
|
||||
cd ./demo;
|
||||
make;
|
||||
./segment_demo testlines.utf8 --algorithm cutMix
|
||||
```
|
||||
|
||||
Output:
|
||||
```
|
||||
@ -98,43 +109,53 @@ Output:
|
||||
我/来自/北京邮电大学/。。。/学号/091111xx/。。。
|
||||
```
|
||||
|
||||
### Server's demo
|
||||
|
||||
引入了husky这个文件夹，husky是一个简单的http服务框架。
|
||||
```
|
||||
cd ./demo;
|
||||
make;
|
||||
./start.sh #启动一个服务，监听11258这个端口(在start.sh里面指定)。
|
||||
```
|
||||
|
||||
关闭和重启分别是`stop.sh`和`restart.sh`
|
||||
|
||||
然后用chrome浏览器打开`http://127.0.0.1:11258/?key=我来自北京邮电大学`
|
||||
(用chrome的原因是chrome的默认编码就是utf-8)
|
||||
|
||||
或者用命令 `curl "http://127.0.0.1:11258/?key=我来自北京邮电大学"`
|
||||
|
||||
|
||||
### 效果分析
|
||||
|
||||
以上依次是MP,HMM,Mix三种方法的效果。
|
||||
|
||||
可以看出效果最好的是Mix，也就是融合MP和HMM的切词算法。即可以准确切出词典已有的词，又可以切出像"杭研"这样的未登录词。
|
||||
|
||||
## Help
|
||||
|
||||
|
||||
## 模块详解
|
||||
|
||||
本项目主要是如下目录组成：
|
||||
|
||||
### Limonp
|
||||
### src
|
||||
|
||||
核心目录，包含主要源代码。
|
||||
|
||||
#### Trie树
|
||||
Trie.cpp/Trie.h 负责载入词典的trie树，主要供Segment模块使用。
|
||||
|
||||
#### Segment模块
|
||||
|
||||
MPSegment.cpp/MPSegment.h
|
||||
(Maximum Probability)最大概率法:负责根据Trie树构建有向无环图和进行动态规划算法，是分词算法的核心。
|
||||
|
||||
HMMSegment.cpp/HMMSegment.h
|
||||
是根据HMM模型来进行分词，主要算法思路是根据(B,E,M,S)四个状态来代表每个字的隐藏状态。
|
||||
HMM模型由dicts/下面的`hmm_model.utf8`提供。
|
||||
分词算法即viterbi算法。
|
||||
|
||||
#### TransCode模块
|
||||
|
||||
TransCode.cpp/TransCode.h 负责转换编码类型，将utf8和gbk转换成`uint16_t`类型，也负责逆转换。
|
||||
|
||||
### src/Husky
|
||||
|
||||
提供服务的框架代码，
|
||||
|
||||
详见： https://github.com/aszxqw/husky
|
||||
|
||||
### src/Limonp
|
||||
|
||||
主要是一些工具函数，例如字符串操作等。
|
||||
直接include就可以使用。
|
||||
|
||||
### cppjieba
|
||||
核心目录，包含主要源代码。
|
||||
make 之后产生libcppjieb.a
|
||||
使用方法参考如上cppcommon
|
||||
|
||||
详见： https://github.com/aszxqw/limonp
|
||||
|
||||
## Help
|
||||
|
||||
### run `./segment_demo` to get help.
|
||||
|
||||
|
||||
@ -1,3 +0,0 @@
|
||||
./segment.demo testlines.utf8 --dictpath ../dicts/jieba.dict.utf8
|
||||
./segment.demo testlines.utf8 --modelpath ../dicts/hmm_model.utf8 --algorithm cutHMM
|
||||
./segment.demo testlines.utf8 --algorithm cutMix
|
||||
Loading…
x
Reference in New Issue
Block a user