Document status: Draft

Chapter II is a flexible ontology / type system for constructing cognitive architectures and language model simulacra, often for characters, known as ems.

It is made of highly decoupled components that work together very well. It is a set of simple primitives assembled by Config and main.py into a functioning em.

Chapter 2 is composable, remixable, and extensible and usable as a library. It is a short program.

See doc/development.md

main.py loads ems from the "ems" folder. An em needs a config.yaml file, which defines its configuration. The configuration keys are defined in ./chapter2/resolve_config.py.

Configuration keys can be written as files within that directory. For instance, you can set an em's discord_token by putting a file named discord_token within its folder.

The character faculty reads files from *.txt files in the {config.name}.chr subdirectory of the em folder.

A faculty is a function that takes the message history ensemble¹, their faculty's configuration, and the global configuration produce ensembles. An ensemble is a lazy, asynchronous iterator of messages², so faculties only pull data as necessary.

A message is a data structure that represents its author, contents, and timestamp.

Message formats convert messages to strings.

A Chapter 2 prompt is made by concatenating³ ensembles. You can control what separates different ensembles by configuring a faculty's⁴ header and footer. The separator for text inside an ensemble is defined by separator.

See ./chapter2/faculties/__init__.py for a list of faculties.

Mufflers filter messages.

An em can have interfaces. The default is one Discord interface. These are currently available:

See ./chapter2/interfaces/__init__.py for a list of interfaces.

Interfaces can have add-ons. An add-on is a mix-in returned by a closure when passed the add-on configuration. Currently, the only available add-on is generate_avatar for the discord interface, which generates an avatar for a Discord bot using a prompt, and can optionally change the avatar at an interval.

See doc/development.md

• pytest unittests in files of the form test_*.py are broken

If you modify Chapter II, please make sure to document how your modified version differs from the original version in CHANGELOG.md. In particular, make sure to document any additional / non-standard features, executables, or modules. Thank you!

Chapter II's source code is made available under the terms of the Artistic License 2.0.