sammo.instructions

sammo.instructions#

Module Contents#

Classes#

Renderer

BaseRenderer

MarkdownRenderer

MarkdownRendererAlt

RawRenderer

XmlRenderer

DocumentComponent

Section

Paragraph

MetaPrompt

FewshotExamples

RandomFewshotExamples

EmbeddingFewshotExamples

InputData

API#

class sammo.instructions.Renderer#
abstract render_section(content, reference_id=None, reference_classes=None, title=None, depth=0)#
abstract render_paragraph(content, reference_id=None, reference_classes=None, depth=0)#
abstract render_metaprompt(content, depth=0, **kwargs)#
class sammo.instructions.BaseRenderer#

Bases: sammo.instructions.Renderer, abc.ABC

render_metaprompt(content, depth=0, **kwargs)#
render_paragraph(content, reference_id=None, reference_classes=None, depth=0)#
class sammo.instructions.MarkdownRenderer(alternative_headings=False)#

Bases: sammo.instructions.BaseRenderer

UNDERLINES = ['=', '-']#
render_section(content, reference_id=None, reference_classes=None, title=None, depth=0)#
render_paragraph(data, **kwargs)#
class sammo.instructions.MarkdownRendererAlt(*args, **kwargs)#

Bases: sammo.instructions.MarkdownRenderer

class sammo.instructions.RawRenderer#

Bases: sammo.instructions.BaseRenderer

render_section(content, reference_id=None, reference_classes=None, title=None, depth=0)#
render_metaprompt(content, depth=0, **kwargs)#
class sammo.instructions.XmlRenderer#

Bases: sammo.instructions.BaseRenderer

render_section(content, reference_id=None, reference_classes=None, title=None, depth=0)#
render_paragraph(content, reference_id=None, reference_classes=None, title=None, depth=0)#
class sammo.instructions.DocumentComponent(content, reference_id: str | None = None, reference_classes: list[str] | None = None)#

Bases: sammo.base.Component

class sammo.instructions.Section(title, content, reference_id=None, reference_classes=None)#

Bases: sammo.instructions.DocumentComponent

static_text(sep='\n')#
set_static_text(text)#
class sammo.instructions.Paragraph(content, reference_id=None, reference_classes=None)#

Bases: sammo.instructions.Section

class sammo.instructions.MetaPrompt(child: list[sammo.instructions.Paragraph | sammo.instructions.Section] | sammo.instructions.Paragraph | sammo.instructions.Section, render_as: beartype.typing.Literal[raw, xml, markdown, markdown - alt] = 'markdown', data_formatter: sammo.dataformatters.DataFormatter | None = None, reference_id: str | None = None, seed: int = 0)#

Bases: sammo.instructions.DocumentComponent

RENDERERS = None#
with_extractor(on_error: beartype.typing.Literal[raise, empty_result] = 'raise')#
class sammo.instructions.FewshotExamples(data: sammo.data.DataTable, n_examples: int | None = None, reference_id: str | None = None)#

Bases: sammo.base.Component

class sammo.instructions.RandomFewshotExamples(data: sammo.data.DataTable, n_examples: int | None = None, reference_id: str | None = None, seed: int = 0)#

Bases: sammo.instructions.FewshotExamples

class sammo.instructions.EmbeddingFewshotExamples(embedder: sammo.base.Runner, data: sammo.data.DataTable, n_examples: int | None = None, reference_id: str | None = None, aggregate: beartype.typing.Literal[roundrobin, max] = 'roundrobin', filter_exact_matches: bool = True, budget: beartype.typing.Literal[absolute, relative] = 'absolute')#

Bases: sammo.instructions.FewshotExamples

MAX_BATCH_SIZE = 1000#
class sammo.instructions.InputData(id_offset: int = 0, reference_id: str | None = None)#

Bases: sammo.base.Component

Contents