Skip to content

Suggested: Clarify naming: SimpleKGPipeline and runtime variable are runners, not customizable pipelines #389

@Frederic-Zhou

Description

@Frederic-Zhou

The current documentation and examples cause confusion by using the term pipeline in a way that implies full customization, when in fact the objects are runners without methods like add_component():

  1. Class name SimpleKGPipeline implies it’s a pipeline that users can modify. In reality, it’s a runner executing a fixed pipeline. Renaming it to SimpleKGPipelineRunner would clarify this distinction.
  2. In the “Using a Config file” example:
pipeline = PipelineRunner.from_config_file(file_path)
await pipeline.run({"text": "my text"})

The variable pipeline is actually a PipelineRunner. Renaming it to pipeline_runner or simple_kg_pipeline_runner would prevent misunderstandings and better communicate that this is an executor, not the pipeline itself.

Impact:
• Helps users understand they cannot call customization methods on these objects.
• Improves clarity and aligns naming with actual API capabilities.
• Reduces confusion for developers trying to extend or customize the pipeline.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions