Skip to content

docs: expand Python API reference - #29

Merged
stackByStack merged 1 commit into
THU-MIG:mainfrom
stackByStack:docs_bindings
Jul 12, 2026
Merged

stackByStack merged 1 commit into
THU-MIG:mainfrom
stackByStack:docs_bindings

Conversation

@stackByStack

Copy link
Copy Markdown
Collaborator

Description*
This PR expands docs/api.md to better document the current Python bindings and server_v2 runtime.

Changes

  • Adds Python package import and installation notes.
  • Documents Engine, EngineConfig, ImageRequest, and VideoRequest.
  • Clarifies supported enum aliases, output types, and exception behavior.
  • Expands server_v2 coverage with startup, endpoints, job lifecycle, result formats, and error schema.
  • Notes that some sampler/scheduler options are accepted by the Python binding but may still be pipeline-specific at runtime.

Verification

  • Cross-checked against bindings/python/src/edge_dit/* and existing Python tests.
  • Documentation-only change; no code changes or test execution.

@stackByStack
stackByStack merged commit 5eeae69 into THU-MIG:main Jul 12, 2026
2 checks passed
@stackByStack
stackByStack deleted the docs_bindings branch July 12, 2026 08:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant