bricks

<p align="center"> <b>触手可及的开源自然语言增强工具。</b> </p> <p align=center> <a href="https://github.com/code-kern-ai/refinery/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-Apache%202.0-success" alt="Apache 2.0 许可证"></a> <a href="https://github.com/code-kern-ai/bricks/discussions"><img src="https://yellow-cdn.veclightyear.com/835a84d5/532f3bad-ffe2-4dd1-bda2-ef2c7f2be9d3.svg?logo=github" alt="GitHub 讨论"></a> <a href="https://discord.gg/qf4rGCEphW"><img src="https://yellow-cdn.veclightyear.com/835a84d5/8425068c-ffaa-48c2-955f-34b35ebdcf40.svg?logo=discord" alt="Discord"></a> <a href="https://twitter.com/MeetKern"><img src="https://yellow-cdn.veclightyear.com/835a84d5/596e7763-d870-4591-98d9-7c529b9e47bf.svg?logo=twitter" alt="Twitter"></a> <a href="https://www.linkedin.com/company/kern-ai"><img src="https://yellow-cdn.veclightyear.com/835a84d5/3885648e-0c98-4f90-85a8-d713c3573b35.svg?logo=linkedin" alt="LinkedIn"></a> <a href="https://www.youtube.com/channel/UCru-6X24b76TRsL6KWMFEFg"><img src="https://yellow-cdn.veclightyear.com/835a84d5/b951ff14-a2c2-43d9-9b52-29e276ea39c6.svg?logo=youtube" alt="YouTube"></a> <a href="https://github.com/orgs/code-kern-ai/projects/7"><img src="https://yellow-cdn.veclightyear.com/835a84d5/f8bf4c40-57f8-45ef-bd44-19293cb0ef5d.svg" alt="路线图"></a> <a href="https://demo.kern.ai/"><img src="https://yellow-cdn.veclightyear.com/835a84d5/771d6100-66ed-4016-a663-ac28c407785f.svg" alt="演示"></a> <a href="https://bricks.kern.ai/"><img src="https://yellow-cdn.veclightyear.com/835a84d5/9f29d0bd-8978-43a3-a817-4f1137a6b074.svg" alt="网站"></a> </p>

浏览bricks以找到适合您项目的宝贵资源；例如，使用句子复杂度估计、情感分析等功能丰富您的文本。

目录

• 为什么选择bricks？
• 演示
• 什么是分类器、提取器和生成器？
• 模块结构
• 入门
• 贡献
• refinery
• 定期更新和通讯
• 许可证

为什么选择bricks？

我们的目标是构建一个现成的自然语言增强库，可以在任何项目中使用，也可以直接在我们的主要项目refinery中使用。我们构建bricks是为了让开发人员更容易构建更好的产品。这就是名称的由来。bricks是一个库，不是指您在存储库中pip install它，而是您可以从在线平台复制粘贴代码。

演示

点击图片或此处观看演示。

什么是分类器、提取器和生成器？

我们通常将它们总结为该存储库中的模块。

• 分类器是将给定文本归类到特定类别的模块。例如，将文本分类为新闻或博客的模块会放在这个文件夹中。它也可以用于增强，例如检测语言等。
• 提取器是从给定文本中检索特定信息的模块。例如，提取文本作者的模块会放在这个文件夹中。
• 生成器基于给定文本创建新内容，或为refinery创建预定义内容的过滤集。例如，将一种语言翻译成另一种语言的模块就是一个生成器。

模块结构

每个模块都有一个具有以下结构的文件夹：

• __init__.py：如果模块可以作为脚本执行，此文件包含入口点。
• README.md：模块的描述，在平台上模块详情页面中显示。
• code_snippet_refinery.md：基于SpaCy输入的显示代码片段。这在模块详情页面中显示。
• code_snippet_common.md：在模块详情页面上显示的适用于任何Python环境的代码片段。这在模块详情页面中显示。
• config.py：用于同步此存储库与在线平台的配置脚本。

如果您想添加新模块，请查看我们的贡献指南。

入门

您可以在bricks中访问此存储库的模块。如果您想自己托管模块，可以按照以下步骤操作。

1. 克隆此存储库
2. （可选）创建虚拟环境
3. 安装依赖项（pip install -r requirements.txt）
4. 运行FastAPI服务器（uvicorn api:api）
5. 访问http://localhost:8000/docs查看文档

贡献

我们会持续将添加到此存储库中的模块添加到在线平台。如果您想添加自己的模块，请遵循贡献指南。如果您有任何问题，随时在Discord上与我们联系。

如果此存储库的内容对您有帮助，请留下星标⭐️。另外，请务必查看refinery。

refinery

查看我们的主要产品refinery，这是另一个开源项目，可帮助您扩展、评估和维护训练数据。您可以直接在refinery中使用bricks中的模块。

定期更新和通讯

我们会定期更新bricks，添加新模块（我们的目标是每周添加两个或更多模块）。如果您想及时了解最新情况，可以订阅我们的通讯。

许可证

本存储库采用Apache许可证2.0版。查看许可证文件的副本。