Skip to content

Commit d367f7b

Browse files
committed
Change FlowParams to PipelineContext
As the POC iterated, we settled on capturing runtime parameters in a PipelineContext object available to all blocks in the pipeline. Signed-off-by: Mark McLoughlin <markmc@redhat.com>
1 parent d524534 commit d367f7b

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

Diff for: docs/sdg/sdg-flow-yaml.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -82,17 +82,16 @@ def parse_custom_flow(content):
8282
logger.warning("The custom flow file may have new features that will be ignored.")
8383
```
8484

85-
### Flow Params
85+
### Pipeline Context
8686

87-
The following parameters are supplied to a Flow constructor and used by the render() method:
87+
The following runtime parameters will no longer be part of the pipeline configuration definition and instead available to blocks via a `PipelineContext` object:
8888

8989
- client - an OpenAI completions API client for talking to the teacher model via the serving backend (i.e. llama-cpp or vLLM)
9090
- model_family - e.g. mixtral or merlinite
9191
- model_id - a path name for the specific teacher model being used
9292
- num_instructions_to_generate - how many samples to generate
93-
- batched - whether the model serving backend supports batched mode
9493

95-
For now, we assume that the `Block` classes know how to use these parameters and there is no need to use any sort of templating in the custom flows that could use these parameters.
94+
For now, we assume there is no need to do any sort of templating in the custom pipelines based on these runtime parameters.
9695

9796
### Model Prompts
9897

0 commit comments

Comments
 (0)