update README (#26)

IDEA-CCNL · Nov 18, 2022 · a4ede94 · a4ede94
1 parent a803523
commit a4ede94
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -19,20 +19,22 @@
 GTS引擎（GTS-Engine）是一款开箱即用且性能强大的自然语言理解引擎，聚焦于小样本任务，能够仅用小样本就能自动化生产NLP模型。它依托于封神榜开源体系的基础模型，并在下游进行了有监督预训练，同时集成了多种小样本学习技术，搭建了一个模型自动生产的流水线。
 
 GTS-Engine计划开源两个系列的引擎，分别为**乾坤鼎**系列和**八卦炉**系列。
-- 乾坤鼎系列是以1.3B参数的大模型为底座，通过大模型进行训练和推理的引擎。
-- 八卦炉系列是以110M参数的base级别模型为底座，融合大模型、数据增强、协调训练等方法进行训练和推理的引擎。
+- **乾坤鼎**系列是以1.3B参数的大模型为底座，通过大模型结合多种小样本学习技术进行训练和推理的引擎。
+- **八卦炉**系列是以110M参数的base模型为底座，融合大模型、数据增强、协同训练等方法进行训练和推理的引擎。
 
 本次发布的是**乾坤鼎**系列的Beta版本，引擎仍在快速迭代中，更多的功能更新请持续关注我们的Github。
 
+您也可以使用我们的模型自动生产平台[GTSfactory](https://gtsfactory.com)来训练你的AI模型。无需海量数据，无需算法基础，只需要上传几份小样本的数据集，就能走完从构建数据集到模型训练、下载部署的全流程，帮助中小企业和个人开发者大大减少获得AI模型的成本。
+
 ## 更新日志
 
-- 2022/11/18，正式发布引擎Beta版本，FewCLUE榜单任务训练过程将陆续公开；
+- `2022/11/18`：正式发布引擎Beta版本，FewCLUE榜单任务训练细节将陆续公开；
 
 ## 即将发布
 
 - 分类任务增加高级模式：支持用户上传无标注数据进行Self Training，进一步提升效果；
 - 更好的使用体验，更清晰的接口，更完善的模块划分，代码快速迭代中；
-- 增加信息抽取任务，SOTA效果即将公开；
+- 增加信息抽取任务，基于统一范式的信息抽取模型即将公开；
 
 ## 安装
 
@@ -44,12 +46,12 @@ GTS-Engine计划开源两个系列的引擎，分别为**乾坤鼎**系列和**
 - 硬件环境需求
     - 乾坤鼎引擎至少需要一张24G显存的RTX3090，使用V100和A100能够获得更好的性能体验；
 
-更多环境需求和软件依赖请参考我们的文档。
+更多环境需求和软件依赖请参考我们的[文档](https://gts-engine-doc.readthedocs.io/en/latest/docs/requirement.html)。
 
-我们提供以下三种安装方式
-1.[pip安装](#pip安装)
-2.[github安装](#github安装)
-3.[Docker安装](#docker安装)
+我们提供以下三种安装方式：
+  - [pip安装](#pip安装)
+  - [github安装](#github安装)
+  - [Docker安装](#docker安装)
 
 #### pip安装
 
@@ -86,9 +88,8 @@ sudo docker pull gtsfactory/gts-engine:v1.0
 
 我们支持两种方式来使用我们的引擎：通过Web服务的方式和通过命令行调用的方式。更多`快速开始`的详情，请参考我们的[文档](https://gts-engine-doc.readthedocs.io/en/latest/docs/quick_start.html)。
 
-1.[Web服务](#web服务)
-2.[调用命令行](#调用命令行)
-
+  - [Web服务](#web服务)
+  - [调用命令行](#调用命令行)
 
 ### 数据预处理
 

diff --git a/gts_engine/qiankunding_core/loss/__init__.py b/gts_engine/qiankunding_core/loss/__init__.py
diff --git a/setup.py b/setup.py
@@ -1,10 +1,14 @@
 from setuptools import setup, find_packages
 
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
 setup(
     name="gts_engine",
-    version="0.1.1",
-    description="gts_engine",
-    long_description="git_engine development suite: a powerful NLU training system",
+    version="0.1.2",
+    description="git_engine development suite: a powerful NLU training system",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
     license="MIT Licence",
     url="https://github.com/IDEA-CCNL/GTS-Engine",
     author="pankunhao",
@@ -38,5 +42,11 @@
             'gts_engine_train = gts_engine.gts_engine_train:main',
             'gts_engine_inference = gts_engine.gts_engine_inference:main'
         ]
-    }
+    },
+
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
 )