TensorFlow函數(shù)教程：tf.queue.PriorityQueue

tf.queue.PriorityQueue函數(shù)

類 PriorityQueue

繼承自： QueueBase

別名：

• 類 tf.PriorityQueue
• 類 tf.io.PriorityQueue

定義在：tensorflow/python/ops/data_flow_ops.py。

一種隊(duì)列實(shí)現(xiàn)，以優(yōu)先順序使元素出列。

有關(guān)此類方法的說明，請參閱tf.QueueBase，這將在下一節(jié)介紹。

__init__

__init__(
    capacity,
    types,
    shapes=None,
    names=None,
    shared_name=None,
    name='priority_queue'
)

創(chuàng)建一個(gè)隊(duì)列，以先進(jìn)先出順序?qū)⒃爻隽小?/p>

PriorityQueue具有有限的容量；支持多個(gè)并發(fā)生產(chǎn)者和使用者；并提供準(zhǔn)確的一次交付。

PriorityQueue包含最多capacity元素的列表。每個(gè)元素是一個(gè)固定長度的張量元組，其dtypes由types描述，其shape可選地由shapes參數(shù)描述。

如果指定了shapes參數(shù)，則隊(duì)列元素的每個(gè)組件必須具有相應(yīng)的固定形狀。如果未指定，則不同的隊(duì)列元素可能具有不同的shape，但不允許使用dequeue_many。

PriorityQueue的Enqueues和Dequeues必須在開頭包含一個(gè)額外的元組條目：priority。priority必須是int64標(biāo)量（用于enqueue）或int64向量（用于enqueue_many）。

參數(shù)：

• capacity：一個(gè)整數(shù)?？梢源鎯υ诖岁?duì)列中的元素?cái)?shù)量的上限。
• types：DType對象列表。除第一優(yōu)先級元素外，types長度必須等于每個(gè)隊(duì)列元素中的張量數(shù)。每個(gè)元素中的第一個(gè)張量是priority，必須是int64類型。
• shapes:（可選）完全定義的TensorShape對象列表，長度與types相同或者為None。
• names:（可選）一個(gè)字符串列表，該字符串命名隊(duì)列中的組件，其長度與dtypes相同或者為None。如果指定，則dequeue方法返回名稱與鍵相同的字典。
  
• shared_name:（可選）如果非空，則此隊(duì)列將在多個(gè)會話中以給定名稱共享。
• name：隊(duì)列操作的可選名稱。

屬性

dtypes

隊(duì)列元素的每個(gè)組件的dtypes列表。

name

底層隊(duì)列的名稱。

names

隊(duì)列元素的每個(gè)組件的names列表。

queue_ref

底層隊(duì)列引用。

shapes

隊(duì)列元素的每個(gè)組件的shapes列表。

方法

close

close(
    cancel_pending_enqueues=False,
    name=None
)

關(guān)閉此隊(duì)列。

此操作表示不再有元素將在給定隊(duì)列中排隊(duì)。隨后enqueue和enqueue_many操作將失敗。如果隊(duì)列中仍有足夠的元素，則后續(xù)的dequeue和dequeue_many操作將繼續(xù)成功。隨后出列的dequeue和dequeue_many操作會阻止等待更多元素（如果沒有調(diào)用close）將立即失敗。

如果cancel_pending_enqueues是True，所有待處理的請求也將被取消。

參數(shù)：

• cancel_pending_enqueues:（可選）布爾值，默認(rèn)為 False（如上所述）。
• name：操作的名稱（可選）。

返回：

關(guān)閉隊(duì)列的操作。

dequeue

dequeue(name=None)

從此隊(duì)列中取消一個(gè)元素。

如果在執(zhí)行此操作時(shí)隊(duì)列為空，則它將阻塞，直到有一個(gè)要出隊(duì)的元素。

在運(yùn)行時(shí)，如果隊(duì)列在執(zhí)行之前或期間是tf.QueueBase.close，則此操作可能會引發(fā)錯(cuò)誤。如果隊(duì)列已關(guān)閉，則隊(duì)列為空，并且沒有可以滿足此請求的待處理入隊(duì)操作，將引發(fā)tf.errors.OutOfRangeError。如果會話是tf.Session.close，則會引發(fā)tf.errors.CancelledError。

參數(shù)：

• name：操作的名稱（可選）。

返回：

已經(jīng)出列的張量的元組。

dequeue_many

dequeue_many(
    n,
    name=None
)

從此隊(duì)列中取出并連接n個(gè)元素。

此操作沿第0維連接隊(duì)列元素組件張量，以生成單個(gè)組件張量。dequeued（出列）元組中的所有組件在第0維中的大小為n。

如果隊(duì)列已關(guān)閉且剩余的元素少于n個(gè)，則會引發(fā)OutOfRange異常。

在運(yùn)行時(shí)，如果隊(duì)列在執(zhí)行之前或期間是tf.QueueBase.close，則此操作可能會引發(fā)錯(cuò)誤。如果隊(duì)列關(guān)閉，則隊(duì)列包含的元素少于n個(gè)，并且沒有可以滿足此請求的待處理enqueue（入隊(duì)）操作，將引發(fā)tf.errors.OutOfRangeError。 如果會話是tf.Session.close，則會引發(fā)tf.errors.CancelledError。

參數(shù)：

• n：包含要出列的元素?cái)?shù)量的標(biāo)量Tensor。
• name：操作的名稱（可選）。

返回：

已出列的連接張量列表。

dequeue_up_to

dequeue_up_to(
    n,
    name=None
)

從此隊(duì)列中取出并連接n個(gè)元素。

注意：所有隊(duì)列都不支持此操作。如果隊(duì)列不支持DequeueUpTo，則會引發(fā)tf.errors.UnimplementedError。

此操作沿第0維連接隊(duì)列元素元素組件張量，以生成單個(gè)組件張量。如果隊(duì)列尚未關(guān)閉，則出列元組中的所有組件將在第0維中具有大小n。

如果隊(duì)列已關(guān)閉并且剩余的元素?cái)?shù)超過0但少于n個(gè)，則不會像tf.QueueBase.dequeue_many那樣引發(fā)tf.errors.OutOfRangeError，而是立即返回少于n個(gè)元素。如果隊(duì)列已關(guān)閉并且隊(duì)列中剩余0個(gè)元素，則會引發(fā)tf.errors.OutOfRangeError，就像在dequeue_many中一樣。否則行為與dequeue_many相同。

參數(shù)：

• n：包含要出列的元素?cái)?shù)量的標(biāo)量Tensor。
• name：操作的名稱（可選）。

返回：

已經(jīng)出列的連接張量的元組。

enqueue

enqueue(
    vals,
    name=None
)

將一個(gè)元素排入此隊(duì)列。

如果在執(zhí)行此操作時(shí)隊(duì)列已滿，則它將阻塞，直到該元素已入隊(duì)。

在運(yùn)行時(shí)，如果隊(duì)列在執(zhí)行之前或期間是tf.QueueBase.close，則此操作可能會引發(fā)錯(cuò)誤。 如果在此操作運(yùn)行之前關(guān)閉隊(duì)列，則將引發(fā)tf.errors.CancelledError。如果此操作被阻止，并且（i）通過cancel_pending_enqueues = True的關(guān)閉操作關(guān)閉隊(duì)列，或者（ii）會話為tf.Session.close，則將引發(fā)tf.errors.CancelledError。

參數(shù)：

• vals：張量，張量的列表或元組，或包含要排隊(duì)的值的字典。
• name：操作的名稱（可選）。

返回：

將新元組的張量排入隊(duì)列的操作。

enqueue_many

enqueue_many(
    vals,
    name=None
)

將零個(gè)或多個(gè)元素排入此隊(duì)列。

此操作沿著第0維度切割每個(gè)組件張量以生成多個(gè)隊(duì)列元素。val中的所有張量在第0維中必須具有相同的大小。

如果在執(zhí)行此操作時(shí)隊(duì)列已滿，它將阻塞，直到所有元素都已入隊(duì)。

在運(yùn)行時(shí)，如果隊(duì)列在執(zhí)行之前或期間是tf.QueueBase.close，則此操作可能會引發(fā)錯(cuò)誤。如果在此操作運(yùn)行之前關(guān)閉隊(duì)列，則將引發(fā)tf.errors.CancelledError。如果此操作被阻止，并且（i）通過cancel_pending_enqueues = True的關(guān)閉操作關(guān)閉隊(duì)列，或者（ii）會話為tf.Session.close，則將引發(fā)tf.errors.CancelledError。

參數(shù)：

• vals：張量，張量的列表或元組，或從中獲取隊(duì)列元素的字典。
• name：操作的名稱（可選）。

返回：

將一批張量的元組排入隊(duì)列的操作。

from_list

from_list(
    index,
    queues
)

使用queues[index]中的隊(duì)列引用創(chuàng)建隊(duì)列。

參數(shù)：

• index：整數(shù)標(biāo)量張量，用于確定所選的輸入。
• queues：QueueBase對象的列表。

返回：

一個(gè)QueueBase對象。

可能引發(fā)的異常：

• TypeError：當(dāng)隊(duì)列不是QueueBase對象的列表時(shí)，或者隊(duì)列的數(shù)據(jù)類型不完全相同時(shí)。

is_closed

is_closed(name=None)

如果隊(duì)列關(guān)閉，則返回true。

如果隊(duì)列關(guān)閉，則此操作返回true，如果隊(duì)列打開，則返回false。

參數(shù)：

• name：操作的名稱（可選）。

返回：

如果隊(duì)列已關(guān)閉則為True，如果隊(duì)列已打開則為false。

size

size(name=None)

計(jì)算此隊(duì)列中的元素?cái)?shù)。

參數(shù)：

• name：操作的名稱（可選）。

返回：

標(biāo)量張量，包含此隊(duì)列中的元素?cái)?shù)。