Skip to main content

A package to use the ComfyAPI

Project description

TechTrash ComfyAPI

TechTrash ComfyAPI est une petite librairie Python qui permet de piloter facilement plusieurs instances ComfyUI en parallèle, en utilisant automatiquement toutes les GPU disponibles, et en gérant les modèles / LoRAs et la récupération des images générées.

Installation

  • Prérequis :

    • Python 3.11+
    • pynvml installé sur la machine avec les GPU
    • Accès à un stockage S3 compatible OVH (endpoint, bucket, clés, etc.)
    • ComfyUI installé sur la machine, avec une instance par GPU si possible
  • Depuis pip (wheel déjà générée) :

pip install techtrash-comfyapi

ou directement depuis le projet :

pip install .

Idée générale

  • Détection GPU : ComfyAPI détecte le nombre et le type de GPU via pynvml.
  • Lancement des instances ComfyUI : pour chaque GPU, la classe lance un process ComfyUI sur un port dédié (subprocess.Popen(...)).
  • Gestion des modèles / LoRAs :
    • vérifie que les modèles demandés existent dans models_path,
    • télécharge les LoRAs manquants depuis une URL vers models_path/loras.
  • Répartition des réglages :
    • certains paramètres sont divisés par le nombre de GPU (ex: batch_size),
    • d’autres restent fixes par GPU (ex: steps).
  • Exécution du workflow :
    • envoie le workflow JSON à chaque instance ComfyUI,
    • attend la fin du traitement,
    • retourne la liste complète des chemins des images générées.

Utilisation rapide

Exemple minimal pour lancer un workflow (pseudo-code simplifié) :

import asyncio
from comfyapi.main import ComfyAPI

api = ComfyAPI(
    api_key="TON_API_KEY",
    s3_endpoint="https://s3.gra.io.cloud.ovh.net",
    s3_bucket="ton-bucket",
    s3_region="gra",
    s3_key_id="TON_KEY_ID",
    s3_secret="TON_SECRET",
    absolute_paths_comfyui=[
        "/chemin/vers/comfyui/gpu0",
        "/chemin/vers/comfyui/gpu1",
    ],
    models_path="/chemin/vers/models",
    ports=[3050, 3051],
)

workflow_json = {...}  # workflow ComfyUI complet
models = [
    {"type": "checkpoints", "name": "model.safetensors"},
]
loras = [
    {"name": "lora.safetensors", "url": "https://.../lora.safetensors"},
]
settings_scaled_by_gpu_count = [
    {"title": "KSampler", "value": 8},   # ex : batch_size
]
settings_fixed_per_gpu = [
    {"title": "KSampler", "value": 20},  # ex : steps
]

async def main():
    images = await api.execute_workflow_TtI(
        workflow_json=workflow_json,
        models=models,
        loras=loras,
        settings_scaled_by_gpu_count=settings_scaled_by_gpu_count,
        settings_fixed_per_gpu=settings_fixed_per_gpu,
    )
    print("Images générées :", images)

asyncio.run(main())

Paramètres principaux

  • ComfyAPI :

    • api_key : clé API pour sécuriser l’accès (si utilisée par tes instances).
    • s3_* : paramètres S3 OVH (endpoint, bucket, région, clés).
    • absolute_paths_comfyui : liste des chemins vers chaque installation ComfyUI.
    • models_path : chemin racine où sont stockés les modèles et LoRAs.
    • ports : ports HTTP de chaque instance ComfyUI.
  • execute_workflow_TtI(...) :

    • workflow_json : workflow ComfyUI complet.
    • models : liste de modèles à vérifier dans models_path.
    • loras : LoRAs à télécharger / vérifier.
    • settings_scaled_by_gpu_count : paramètres divisés par le nombre de GPU.
    • settings_fixed_per_gpu : paramètres identiques sur chaque GPU.

Comment tester rapidement

  • 1. Vérifier l’installation :
python -c "import comfyapi; print('Ok')"
  • 2. Lancer un petit script avec un workflow simple (même machine que ComfyUI).
  • 3. Surveiller les logs : tu verras l’initialisation des GPU, le lancement des instances ComfyUI et la liste des images générées.

Ce README reste volontairement bref : il donne une vue d’ensemble de la librairie, comment l’installer, l’utiliser rapidement, et quels sont les paramètres importants. Tu peux me demander une version plus détaillée ou orientée prod si besoin.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

techtrash_comfyapi-0.3.0.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

techtrash_comfyapi-0.3.0-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

Details for the file techtrash_comfyapi-0.3.0.tar.gz.

File metadata

  • Download URL: techtrash_comfyapi-0.3.0.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for techtrash_comfyapi-0.3.0.tar.gz
Algorithm Hash digest
SHA256 9163325ee8d56d552ff22a306bcf1c139c4ef7cd9c3ab55c00f9e6c782af6786
MD5 f928f70b4a24a3364d2bfe0dad638075
BLAKE2b-256 8877d7b3783b95302e142100343750388082d72a9d53c1280470672c07e1fb57

See more details on using hashes here.

File details

Details for the file techtrash_comfyapi-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for techtrash_comfyapi-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 68e3469e198c70bb0e756cb20c7cefa38ae4985a758c4b17345ad6eeb55246e9
MD5 36df3311c138366364ba42f8daf36c22
BLAKE2b-256 086cb3904cfd8858c8c456291a67b9e29e32b305119b0088179c48814973b282

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page