[PyOV] AsyncInferQueue documentation notice about iteration limit (#18042)

This commit is contained in:
Anastasia Kuporosova authored and GitHub committed 2023-06-15 09:23:26 +02:00
1 parent 52834659c4
commit 7fd394e87e
2 files changed
+12

No files matched your search

@@ -280,6 +280,10 @@ class AsyncInferQueue(AsyncInferQueueBase):
def __iter__(self) -> Iterable[InferRequest]:
"""Allows to iterate over AsyncInferQueue.
Resulting objects are guaranteed to work with read-only methods like getting tensors.
Any mutating methods (e.g. start_async, set_callback) of a single request
will put the parent AsyncInferQueue object in an invalid state.
:return: a generator that yields InferRequests.
:rtype: Iterable[openvino.runtime.InferRequest]
"""
@@ -288,6 +292,10 @@ class AsyncInferQueue(AsyncInferQueueBase):
def __getitem__(self, i: int) -> InferRequest:
"""Gets InferRequest from the pool with given i id.
Resulting object is guaranteed to work with read-only methods like getting tensors.
Any mutating methods (e.g. start_async, set_callback) of a request
will put the parent AsyncInferQueue object in an invalid state.
:param i: InferRequest id.
:type i: int
:return: InferRequests from the pool with given id.