v1.0.7

README.md

@@ -32,10 +32,17 @@
    + RE2（Simple-Effective-Text-Matching）
 
 # Usages
+可以选择通过pip进行安装并使用（如下），或者直接下载源码到本地，集成到项目中：
+```
+pip3 install text-sim
+```
+
 ```
 1：examples目录下有不同模型对应的 preprocess/train/evalute代码，可自行修改
 2：如下示例从examples中引入actuator方法，准备好对应的模型配置文件即可执行
 3：examples目录下的inference.py为训练好的模型推理代码
+4：主体代码放在sim下，TensorFlow和Pytorch两个版本分开存放，引用方式基本保持一致
+5：相关工具包括word2vec、tokenizer、data_format统一放在sim的tools下
 ```
 
 ### TF-IDF

setup.py

@@ -1,23 +1,38 @@
 #! -*- coding: utf-8 -*-
 
+import codecs
+import pathlib
 from setuptools import setup
 from setuptools import find_packages
 
+here = pathlib.Path(__file__).parent.resolve()
+long_description = (here / "README.md").read_text(encoding="utf-8")
+with codecs.open("requirements.txt", "r", "utf8") as reader:
+    install_requires = list(map(lambda x: x.strip(), reader.readlines()))
+
 setup(
-    name='text-sim',
-    version='0.0.1',
-    description='an elegant text-sim',
-    long_description='text-sim: https://github.com/DengBoCong/sim',
+    name="text-sim",
+    version="1.0.7",
+    description="Chinese text similarity calculation package of Tensorflow/Pytorch",
+    long_description=long_description,
     long_description_content_type="text/markdown",
-    license='MIT License',
-    url='https://github.com/DengBoCong/sim',
-    author='DengBoCong',
-    author_email='[email protected]',
-    install_requires=['scikit-learn>=0.23.2', 'numpy>=1.19.2'],
+    license="MIT License",
+    url="https://github.com/DengBoCong/text-similarity",
+    author="DengBoCong",
+    author_email="[email protected]",
+    install_requires=install_requires,
     packages=find_packages(),
     classifiers=[
         "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
     ],
+    keywords="similarity, tensorflow, pytorch, classification",
+    project_urls={
+        "Bug Reports": "https://github.com/DengBoCong/text-similarity/issues",
+        "Funding": "https://pypi.org/project/text-sim/",
+        "Source": "https://github.com/DengBoCong/text-similarity",
+    },
 )

sim/__init__.py

@@ -1,4 +1,4 @@
 #! -*- coding: utf-8 -*-
 
 name = "sim"
-__version__ = "0.0.1"
+__version__ = "1.0.7"