Skip to content

Commit e7aa618

Browse files
authored
Enrichment workflow DAG nodes: clarify when enrichments are generated (#697)
1 parent 19654de commit e7aa618

File tree

4 files changed

+56
-16
lines changed

4 files changed

+56
-16
lines changed
Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
11
<Warning>
2-
Image summary descriptions are generated only when the **Partitioner** node in a workflow is set to use the **High Res** [partitioning strategy](/ui/partitioning) and
3-
the workflow also contains an image description enrichment node.
2+
Unstructured can potentially generate image summary descriptions only for workflows that are configured as follows:
3+
4+
- With a **Partitioner** node set to use the **Auto** or **High Res** partitioning strategy, and an image summary description node is added.
5+
- With a **Partitioner** node set to use the **VLM** partitioning strategy. No image summary description node is needed (or allowed).
6+
7+
Even with these configurations, Unstructured actually generates image summary descriptions only for files that contain images and are also eligible
8+
for processing with the following partitioning strategies:
9+
10+
- **High Res**, when the workflow's **Partitioner** node is set to use **Auto** or **High Res**.
11+
- **VLM** or **High Res**, when the workflow's **Partitioner** node is set to use **VLM**.
412

5-
Setting the **Partitioner** node to use **Auto**, **VLM**, or **Fast** in a workflow that also contains an image description enrichment node
6-
will not produce any image summary descriptions, and it could also cause the workflow to stop running or produce unexpected results.
13+
Unstructured never generates image summary descriptions for workflows that are configured as follows:
14+
15+
- With a **Partitioner** node set to use the **Fast** partitioning strategy.
16+
- With a **Partitioner** node set to use the **Auto**, **High Res**, or **VLM** partitioning strategy, for all files that Unstructured encounters that do not contain images.
717
</Warning>
Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
11
<Warning>
2-
Image summary descriptions, table summary descriptions, and table-to-HTML output is generated only when the **Partitioner** node in a workflow is set to use the **High Res** [partitioning strategy](/ui/partitioning) and
3-
the workflow also contains an image description, table description, or table-to-HTML enrichment node.
2+
Unstructured can potentially generate image summary descriptions, table summary descriptions, and table-to-HTML output only for workflows that are configured as follows:
3+
4+
- With a **Partitioner** node set to use the **Auto** or **High Res** partitioning strategy, and an image summary description node, table summary description node, or table-to-HTML output node is added.
5+
- With a **Partitioner** node set to use the **VLM** partitioning strategy. No image summary description node, table summary description node, or table-to-HTML output node is needed (or allowed).
6+
7+
Even with these configurations, Unstructured actually generates image summary descriptions, table summary descriptions, and table-to-HTML output only for files that contain images or tables and are also eligible
8+
for processing with the following partitioning strategies:
9+
10+
- **High Res**, when the workflow's **Partitioner** node is set to use **Auto** or **High Res**.
11+
- **VLM** or **High Res**, when the workflow's **Partitioner** node is set to use **VLM**.
412

5-
Setting the **Partitioner** node to use **Auto**, **VLM**, or **Fast** in a workflow that also contains an image description, table description, or table-to-HTML enrichment node
6-
will not generate any image summary descriptions, table summary descriptions, or table-to-HTML output, and it could also cause the workflow to stop running or produce unexpected results.
13+
Unstructured never generates image summary descriptions, table summary descriptions, or table-to-HTML output for workflows that are configured as follows:
14+
15+
- With a **Partitioner** node set to use the **Fast** partitioning strategy.
16+
- With a **Partitioner** node set to use the **Auto**, **High Res**, or **VLM** partitioning strategy, for all files that Unstructured encounters that do not contain images or tables.
717
</Warning>
Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
11
<Warning>
2-
Table summary descriptions are generated only when the **Partitioner** node in a workflow is set to use the **High Res** [partitioning strategy](/ui/partitioning) and
3-
the workflow also contains a table description enrichment node.
2+
Unstructured can potentially generate table summary descriptions only for workflows that are configured as follows:
3+
4+
- With a **Partitioner** node set to use the **Auto** or **High Res** partitioning strategy, and a table summary description node is added.
5+
- With a **Partitioner** node set to use the **VLM** partitioning strategy. No table summary description node is needed (or allowed).
6+
7+
Even with these configurations, Unstructured actually generates table summary descriptions only for files that contain tables and are also eligible
8+
for processing with the following partitioning strategies:
9+
10+
- **High Res**, when the workflow's **Partitioner** node is set to use **Auto** or **High Res**.
11+
- **VLM** or **High Res**, when the workflow's **Partitioner** node is set to use **VLM**.
412

5-
Setting the **Partitioner** node to use **Auto**, **VLM**, or **Fast** in a workflow that also contains a table description enrichment node
6-
will not produce any table summary descriptions, and it could also cause the workflow to stop running or produce unexpected results.
13+
Unstructured never generates table summary descriptions for workflows that are configured as follows:
14+
15+
- With a **Partitioner** node set to use the **Fast** partitioning strategy.
16+
- With a **Partitioner** node set to use the **Auto**, **High Res**, or **VLM** partitioning strategy, for all files that Unstructured encounters that do not contain tables.
717
</Warning>
Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
11
<Warning>
2-
Table-to-HTML generation happens only when the **Partitioner** node in a workflow is set to use the **High Res** [partitioning strategy](/ui/partitioning) and
3-
the workflow also contains a table-to-HTML enrichment node.
2+
Unstructured can potentially generate table-to-HTML output only for workflows that are configured as follows:
3+
4+
- With a **Partitioner** node set to use the **Auto** or **High Res** partitioning strategy, and a table-to-HTML output node is added.
5+
- With a **Partitioner** node set to use the **VLM** partitioning strategy. No table-to-HTML output node is needed (or allowed).
46

5-
Setting the **Partitioner** node to use **Auto**, **VLM**, or **Fast** in a workflow that also contains a table-to-HTML enrichment node
6-
will not generate any table-to-HTML output, and it could also cause the workflow to stop running or produce unexpected results.
7+
Even with these configurations, Unstructured actually generates table-to-HTML output only for files that contain tables and are also eligible
8+
for processing with the following partitioning strategies:
9+
10+
- **High Res**, when the workflow's **Partitioner** node is set to use **Auto** or **High Res**.
11+
- **VLM** or **High Res**, when the workflow's **Partitioner** node is set to use **VLM**.
12+
13+
Unstructured never generates table-to-HTML output for workflows that are configured as follows:
14+
15+
- With a **Partitioner** node set to use the **Fast** partitioning strategy.
16+
- With a **Partitioner** node set to use the **Auto**, **High Res**, or **VLM** partitioning strategy, for all files that Unstructured encounters that do not contain tables.
717
</Warning>

0 commit comments

Comments
 (0)