diff options
| author | Ian Johnson <ian.johnson@appliedlanguage.com> | 2012-08-14 14:00:02 +0400 |
|---|---|---|
| committer | Ian Johnson <ian.johnson@appliedlanguage.com> | 2012-08-14 14:00:02 +0400 |
| commit | 1861327c7b7241d7ed919125330d2cf359615dca (patch) | |
| tree | e2765fbbcbbfcca29aee857d3d80b3f170d7feb7 /README.md | |
| parent | a7f97ccc9de283dbe7252f7fdd38f2f17ec95f6b (diff) | |
Update README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 44 |
1 files changed, 31 insertions, 13 deletions
@@ -51,30 +51,48 @@ There are no rules for creating your pipelines. Pipelines, pipeline components, ### Pipeline Functions -#### `helpers.cons_pipeline(input_wire, component, output_wire)` -> Construct a pipeline from a component and two wires. The input wire shall convert a real world input into the expected input for the component, and the output wire shall convert the output from the component into an expected real world value. The funtion returns a `core.arrows.KleisliArrow` object that represents the pipeline. +#### Constructing a Pipeline + helpers.cons_pipeline(input_wire, component, output_wire) -#### `helpers.run_pipeline(pipeline, input, state)` +Construct a pipeline from a component and two wires. The input wire shall convert a real world input into the expected input for the component, and the output wire shall convert the output from the component into an expected real world value. The funtion returns a `core.arrows.KleisliArrow` object that represents the pipeline. -#### `helpers.eval_pipeline(pipeline, input, state)` +#### Running a Pipeline + helpers.run_pipeline(pipeline, input, state) -#### `helpers. exec_pipeline(pipeline, input, state)` +#### Evaluating a Pipeline + helpers.eval_pipeline(pipeline, input, state) + +#### Executing a Pipeline + helpers.exec_pipeline(pipeline, input, state) ### Pipeline Component Functions -#### `helpers.cons_function_component(function, - input_forming_function = None, - output_forming_function = None, - state_mutator = None)` +#### Constructing a Function Based Pipeline Component + + helpers.cons_function_component(function, + input_forming_function = None, + output_forming_function = None, + state_mutator = None) + +#### Constructing a Subprocess Based Pipeline Component -#### `helpers.cons_subprocess_component(process_pipe, input_forming_function, output_forming_function, state_mutator = None)` + helpers.cons_subprocess_component(process_pipe, + input_forming_function, + output_forming_function, + state_mutator = None) ### Wire Functions -#### `helpers.cons_wire(schema_conv_function)` +#### Constructing a Function Based Wire + + helpers.cons_wire(schema_conv_function) + +#### Constructing a Dictionary Based Wire + + helpers.cons_dictionary_wire(conversions) -#### `helpers.cons_dictionary_wire(conversions)` +#### Wire Up Two Pipeline Components -#### `helpers.wire_components(component_one, component_two, wire)` + helpers.wire_components(component_one, component_two, wire) |