This is an automated email from the ASF dual-hosted git repository.
joshfell pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 22654fa2f6 Use cards when describing priority weighting methods
(#36411)
22654fa2f6 is described below
commit 22654fa2f618d68d394fb837446ad2d4e3b81743
Author: Josh Fell <[email protected]>
AuthorDate: Sun Dec 24 19:31:59 2023 -0500
Use cards when describing priority weighting methods (#36411)
---
.../priority-weight.rst | 55 ++++++++++++----------
1 file changed, 29 insertions(+), 26 deletions(-)
diff --git
a/docs/apache-airflow/administration-and-deployment/priority-weight.rst
b/docs/apache-airflow/administration-and-deployment/priority-weight.rst
index 87a9288ddc..3807b3ee5d 100644
--- a/docs/apache-airflow/administration-and-deployment/priority-weight.rst
+++ b/docs/apache-airflow/administration-and-deployment/priority-weight.rst
@@ -22,40 +22,43 @@ Priority Weights
``priority_weight`` defines priorities in the executor queue. The default
``priority_weight`` is ``1``, and can be
bumped to any integer. Moreover, each task has a true ``priority_weight`` that
is calculated based on its
-``weight_rule`` which defines weighting method used for the effective total
priority weight of the task.
+``weight_rule`` which defines the weighting method used for the effective
total priority weight of the task.
-By default, Airflow's weighting method is ``downstream``. You can find other
weighting methods in
-:class:`airflow.utils.WeightRule`.
+Below are the weighting methods. By default, Airflow's weighting method is
``downstream``.
-There are three weighting methods.
-- downstream
+.. grid:: 3
- The effective weight of the task is the aggregate sum of all
- downstream descendants. As a result, upstream tasks will have
- higher weight and will be scheduled more aggressively when
- using positive weight values. This is useful when you have
- multiple DAG run instances and desire to have all upstream
- tasks to complete for all runs before each DAG can continue
- processing downstream tasks.
+ .. grid-item-card:: ``downstream``
+ :shadow: none
-- upstream
+ The effective weight of the task is the aggregate sum of all
+ downstream descendants. As a result, upstream tasks will have
+ higher weight and will be scheduled more aggressively when
+ using positive weight values. This is useful when you have
+ multiple DAG run instances and desire to have all upstream
+ tasks to complete for all runs before each DAG can continue
+ processing downstream tasks.
- The effective weight is the aggregate sum of all upstream ancestors.
- This is the opposite where downstream tasks have higher weight
- and will be scheduled more aggressively when using positive weight
- values. This is useful when you have multiple DAG run instances
- and prefer to have each DAG complete before starting upstream
- tasks of other DAG runs.
+ .. grid-item-card:: ``upstream``
+ :shadow: none
-- absolute
+ The effective weight is the aggregate sum of all upstream ancestors.
+ This is the opposite where downstream tasks have higher weight
+ and will be scheduled more aggressively when using positive weight
+ values. This is useful when you have multiple DAG run instances
+ and prefer to have each DAG complete before starting upstream
+ tasks of other DAG runs.
- The effective weight is the exact ``priority_weight`` specified
- without additional weighting. You may want to do this when you
- know exactly what priority weight each task should have.
- Additionally, when set to ``absolute``, there is bonus effect of
- significantly speeding up the task creation process as for very
- large DAGs
+ .. grid-item-card:: ``absolute``
+ :shadow: none
+
+ The effective weight is the exact ``priority_weight`` specified
+ without additional weighting. You may want to do this when you
+ know exactly what priority weight each task should have.
+ Additionally, when set to ``absolute``, there is bonus effect of
+ significantly speeding up the task creation process as for very
+ large DAGs.
The ``priority_weight`` parameter can be used in conjunction with
:ref:`concepts:pool`.
