README.md

Table of Contents

• example_library
  • add_two_numbers
• MemoryReadingAtomicFlow
  • MemoryReadingAtomicFlow
    • __init__
    • run
• run
• __init__

example_library

add_two_numbers

def add_two_numbers(a, b)

Add two numbers together and return the result

Arguments:

• a: first number
• b: second number

Returns:

sum of a and b

MemoryReadingAtomicFlow

MemoryReadingAtomicFlow Objects

class MemoryReadingAtomicFlow(AtomicFlow)

A flow to read memory from given files.

Any composite flow that uses this flow should have memory_files: Dict[str, str] which maps memory name to its memory file location in the flow_state

Input Interface:

• memory_files : name of the Dict which maps the memory name to its file location e.g. {"plan": "examples/JARVIS/plan.txt"}

Output_Interface:

• corresponding memory content, for example, code_library. There could be multiple memory content returned.

Configuration Parameters:

• input_interface: input interface of the flow
• output_interface: output interface of the flow

__init__

def __init__(**kwargs)

This is the constructor of the :class:MemoryReadingAtomicFlow class.

Arguments:

• kwargs (Dict[str, Any]): additional arguments to pass to the :class:AtomicFlow constructor

run

def run(input_data: Dict[str, Any])

Run the flow.

Arguments:

• input_data (Dict[str, Any]): the input data

Returns:

Dict[str, Any]: the output data

run

__init__