diff --git a/invokeai/app/api/routers/sessions.py b/invokeai/app/api/routers/sessions.py index d743ee70ac..24bbbb2380 100644 --- a/invokeai/app/api/routers/sessions.py +++ b/invokeai/app/api/routers/sessions.py @@ -47,7 +47,7 @@ async def create_batch( graph: Graph = Body(description="The graph to initialize the session with"), batch: Batch = Body(description="Batch config to apply to the given graph"), ) -> BatchProcessResponse: - """Creates and starts a new new batch process""" + """Creates a batch process""" batch_process_res = ApiDependencies.invoker.services.batch_manager.create_batch_process(batch, graph) return batch_process_res @@ -63,6 +63,7 @@ async def create_batch( async def start_batch( batch_process_id: str = Path(description="ID of Batch to start"), ) -> Response: + """Executes a batch process""" try: ApiDependencies.invoker.services.batch_manager.run_batch_process(batch_process_id) return Response(status_code=202) @@ -78,7 +79,7 @@ async def start_batch( async def cancel_batch( batch_process_id: str = Path(description="The id of the batch process to cancel"), ) -> Response: - """Creates and starts a new new batch process""" + """Cancels a batch process""" ApiDependencies.invoker.services.batch_manager.cancel_batch_process(batch_process_id) return Response(status_code=202) @@ -89,7 +90,7 @@ async def cancel_batch( responses={200: {"model": list[BatchProcessResponse]}}, ) async def list_incomplete_batches() -> list[BatchProcessResponse]: - """Gets a list of sessions, optionally searching""" + """Lists incomplete batch processes""" return ApiDependencies.invoker.services.batch_manager.get_incomplete_batch_processes() @@ -99,7 +100,7 @@ async def list_incomplete_batches() -> list[BatchProcessResponse]: responses={200: {"model": list[BatchProcessResponse]}}, ) async def list_batches() -> list[BatchProcessResponse]: - """Gets a list of sessions, optionally searching""" + """Lists all batch processes""" return ApiDependencies.invoker.services.batch_manager.get_batch_processes() @@ -123,7 +124,7 @@ async def get_batch( async def get_batch_sessions( batch_process_id: str = Path(description="The id of the batch process to get"), ) -> list[BatchSession]: - """Gets a list of BatchSessions Batch Process""" + """Gets a list of batch sessions for a given batch process""" return ApiDependencies.invoker.services.batch_manager.get_sessions(batch_process_id) diff --git a/invokeai/app/services/batch_manager.py b/invokeai/app/services/batch_manager.py index 50799f4239..9f7927687c 100644 --- a/invokeai/app/services/batch_manager.py +++ b/invokeai/app/services/batch_manager.py @@ -27,34 +27,42 @@ class BatchProcessResponse(BaseModel): class BatchManagerBase(ABC): @abstractmethod def start(self, invoker: Invoker) -> None: + """Starts the BatchManager service""" pass @abstractmethod def create_batch_process(self, batch: Batch, graph: Graph) -> BatchProcessResponse: + """Creates a batch process""" pass @abstractmethod def run_batch_process(self, batch_id: str) -> None: + """Runs a batch process""" pass @abstractmethod def cancel_batch_process(self, batch_process_id: str) -> None: + """Cancels a batch process""" pass @abstractmethod def get_batch(self, batch_id: str) -> BatchProcessResponse: + """Gets a batch process""" pass @abstractmethod def get_batch_processes(self) -> list[BatchProcessResponse]: + """Gets all batch processes""" pass @abstractmethod def get_incomplete_batch_processes(self) -> list[BatchProcessResponse]: + """Gets all incomplete batch processes""" pass @abstractmethod def get_sessions(self, batch_id: str) -> list[BatchSession]: + """Gets the sessions associated with a batch""" pass