贡献组件
新组件作为 CustomComponent 类的对象添加。
任何依赖项都添加到 pyproject.toml 文件中。
为 Langflow 贡献一个示例组件
任何人都可以贡献一个示例组件。例如,如果您创建了一个名为 MyCustomDocumentLoader 的新文档加载器,您可以按照以下步骤将其贡献给 Langflow。
- 将您的加载器编写为 CustomComponent 类的对象。您将创建一个新类
MyCustomDocumentLoader
,该类将继承自CustomComponent
并覆盖基类的方法。 - 定义可选属性,例如
display_name
、description
和documentation
,以提供有关您的自定义组件的信息。 - 实现
build_config
方法来定义自定义组件的配置选项。 - 实现
build
方法来定义根据build_config
方法中指定的输入参数并返回所需输出的逻辑。 - 将代码添加到 /components/documentloaders 文件夹。
- 将依赖项添加到 /documentloaders/init.py 中,形式为
from .MyCustomDocumentLoader import MyCustomDocumentLoader
。 - 将任何新的依赖项添加到 pyproject.toml 文件中。
- 提交组件的文档。对于此示例,您可以将文档提交到 加载器页面。
- 将您的更改作为拉取请求提交。Langflow 团队将查看并提出修改建议,然后将您的组件添加到 Langflow 中。