AutoTransform

Documents

  • Overview
  • Components
  • Best Practices
  • Scheduled Runs
  • Managing Changes
  • Extending For Your Organization
  • Contributing To AutoTransform

Code

  • AutoTransform (autotransform)
    • Core
      • Schema Package (autotransform.schema)
      • Scripts (autotransform.scripts)
      • Config Package (autotransform.config)
      • Runner Package (autotransform.runner)
      • Item Package (autotransform.item)
      • Change Package (autotransform.change)
      • Step Package (autotransform.step)
      • Event Package (autotransform.event)
        • EventHandler (autotransform.event.handler)
        • EventNotifier (autotransform.event.notifier.base)
        • ConsoleEventNotifier (autotransform.event.notifier.console)
        • Event (autotransform.event.base)
        • LoggingLevel (autotransform.event.logginglevel)
        • EventType (autotransform.event.type)
        • Batch Related Events (autotransform.event.batch)
        • DebugEvent (autotransform.event.debug)
        • Github Related Events (autotransform.event.github)
        • Management related events (autotransform.event.manage)
        • AI Model Related Events (autotransform.event.model)
        • RunEvent (autotransform.event.run)
        • Runner Related Events (autotransform.event.runner)
        • ScheduleRunEvent (autotransform.event.schedulerun)
        • Script Related Events (autotransform.event.script)
        • Util Related Events (autotransform.event.util)
        • DebugEvent (autotransform.event.debug)
        • WarningEvent (autotransform.event.warning)
      • Utilities (autotransform.util)
      • Model Package (autotransform.model)
    • Schema Components
AutoTransform
  • AutoTransform (autotransform)
  • Event Package (autotransform.event)
  • AI Model Related Events (autotransform.event.model)
  • View page source

AI Model Related Events (autotransform.event.model)

The AIModel events are used to handle events related to usage of AI Models in AutoTransform.

class autotransform.event.model.AIModelCommandFailureEvent(data: TData)

Bases: Event[AIModelCommandFailureEventData]

A simple event to log AIModel command run failures.

static get_logging_level() → LoggingLevel

The logging level for events of this type.

Returns:

The logging detail required to log this event.

Return type:

LoggingLevel

static get_type() → EventType

Used to represent the type of Event, output to logs.

Returns:

The unique type associated with this Event.

Return type:

EventType

class autotransform.event.model.AIModelCommandFailureEventData

Bases: TypedDict

The data for a AIModelCommandFailureEvent. Contains the information that will be logged when the event is triggered.

command: Command
exception: Exception
item: Item
class autotransform.event.model.AIModelCompletionEvent(data: TData)

Bases: Event[AIModelCompletionEventData]

A simple event to log AIModel completions.

static get_logging_level() → LoggingLevel

The logging level for events of this type.

Returns:

The logging detail required to log this event.

Return type:

LoggingLevel

static get_type() → EventType

Used to represent the type of Event, output to logs.

Returns:

The unique type associated with this Event.

Return type:

EventType

class autotransform.event.model.AIModelCompletionEventData

Bases: TypedDict

The data for a AIModelCompletionEvent. Contains the information that will be logged when the event is triggered.

completion: str
input_tokens: int
output_tokens: int
class autotransform.event.model.AIModelCompletionFailureEvent(data: TData)

Bases: Event[AIModelCompletionFailureEventData]

A simple event to log AIModel completion failures.

static get_logging_level() → LoggingLevel

The logging level for events of this type.

Returns:

The logging detail required to log this event.

Return type:

LoggingLevel

static get_type() → EventType

Used to represent the type of Event, output to logs.

Returns:

The unique type associated with this Event.

Return type:

EventType

class autotransform.event.model.AIModelCompletionFailureEventData

Bases: TypedDict

The data for a AIModelCompletionFailureEvent. Contains the information that will be logged when the event is triggered.

exception: Exception
item: Item
Previous Next

© Copyright 2022, Nathan Rockenbach.

Built with Sphinx using a theme provided by Read the Docs.