Start Generation

start-generation

This skill covers the generation routes for starting, streaming, canceling, downloading, and previewing.

Trigger: When generating content.

Quick Reference

Critical Patterns (Summary)

• Start Generation: Initiates the generation process.
• Stream Generation: Streams the ongoing generation process.

Critical Patterns (Detailed)

Start Generation

Initiates the generation process by calling the start_generation function.

from apps.server.app.routes.generate import start_generation

result = start_generation(data)

Stream Generation

Streams the ongoing generation process using the stream_generation function.

from apps.server.app.routes.generate import stream_generation

for chunk in stream_generation(generation_id):
    process_chunk(chunk)

When to Use

• When a user requests to start a new generation task.
• When streaming updates for a long-running generation process.

Commands

docker-compose up
python apps/server/app/main.py

Anti-Patterns

Don't: Start without validation

Starting a generation without validating input can lead to errors and unexpected behavior.

# BAD
start_generation(None)