From bc0e8a31c44a92ed07b9dfc07c7bca8f8a8552c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Zientkiewicz?= Date: Tue, 28 May 2024 13:42:50 +0200 Subject: [PATCH] Add a warning about pipeline definition being executed only once. (#5486) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Michał Zientkiewicz --- docs/pipeline.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/pipeline.rst b/docs/pipeline.rst index 2bd5d54d10..2c8770d3d0 100644 --- a/docs/pipeline.rst +++ b/docs/pipeline.rst @@ -50,6 +50,13 @@ The resulting graph is: .. _processing_graph_structure: +.. important:: + The pipeline definition function is excuted only once, when the pipeline is built, + and typically returns a ``dali.DataNode`` object or a tuple of thereof. + For convenience, it's possible to return other types, such as NumPy arrays, but those + are treated as constants and evaluated only once. + + Processing Graph Structure ^^^^^^^^^^^^^^^^^^^^^^^^^^