docs: Time aware fairness documentation

[itsomri]

Description

Related Issues

Fixes #

Checklist

Note: Ensure your PR title follows the Conventional Commits format (e.g., feat(scheduler): add new feature)

• Self-reviewed
• Added/updated tests (if needed)
• Updated CHANGELOG.md (if needed)
• Updated documentation (if needed)

Breaking Changes

Additional Notes

[github-actions]

Merging this branch changes the coverage (2 decrease, 1 increase)

Impacted Packages	Coverage Δ	🤖
github.com/NVIDIA/KAI-scheduler/pkg/apis/kai/v1	0.00% (ø)
github.com/NVIDIA/KAI-scheduler/pkg/env-tests/timeaware	0.00% (ø)
github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/common	52.25% (ø)
github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/prometheus	51.54% (+0.43%)	👍
github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/scheduler	78.17% (-0.66%)	👎
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache	35.14% (ø)
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/usagedb/api	29.85% (-31.69%)	💀 💀 💀
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/usagedb/fake	0.00% (ø)
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/usagedb/prometheus	19.15% (ø)

---

Coverage by file

Changed files (no unit tests)

Changed File	Coverage Δ	Total	Covered	Missed	🤖
github.com/NVIDIA/KAI-scheduler/pkg/apis/kai/v1/schedulingshard_types.go	0.00% (ø)	5	0	5
github.com/NVIDIA/KAI-scheduler/pkg/apis/kai/v1/zz_generated.deepcopy.go	0.00% (ø)	265 (+7)	0	265 (+7)
github.com/NVIDIA/KAI-scheduler/pkg/env-tests/timeaware/timeaware.go	0.00% (ø)	150	0	150
github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/common/common.go	52.25% (ø)	111	58	53
github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/prometheus/resources.go	83.48% (+0.29%)	115 (+2)	96 (+2)	19	👍
github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/scheduler/resources_for_shard.go	86.41% (-1.35%)	103 (+5)	89 (+3)	14 (+2)	👎
github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/scheduler/scheduler.go	52.94% (ø)	34	18	16
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/cache.go	53.79% (ø)	132	71	61
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/usagedb/api/defaults.go	50.00% (-5.88%)	30 (-4)	15 (-4)	15	👎
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/usagedb/api/interface.go	13.51% (-86.49%)	37 (+32)	5	32 (+32)	💀 💀 💀 💀 💀
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/usagedb/fake/fake_with_history.go	0.00% (ø)	51	0	51
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/usagedb/prometheus/prometheus.go	19.15% (ø)	94	18	76

Please note that the "Total", "Covered", and "Missed" counts above refer to code statements instead of lines of code. The value in brackets refers to the test coverage of that file in the old version of the code.

Changed unit test files

• github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/prometheus/prometheus_test.go
• github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/usagedb/api/usage_params_test.go

[github-actions]

Merging this branch changes the coverage (2 decrease, 1 increase)

Impacted Packages	Coverage Δ	🤖
github.com/NVIDIA/KAI-scheduler/pkg/apis/kai/v1	0.00% (ø)
github.com/NVIDIA/KAI-scheduler/pkg/env-tests/timeaware	0.00% (ø)
github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/common	52.25% (ø)
github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/prometheus	51.54% (+0.43%)	👍
github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/scheduler	78.32% (-0.51%)	👎
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache	35.14% (ø)
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/usagedb/api	29.85% (-31.69%)	💀 💀 💀
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/usagedb/fake	0.00% (ø)
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/usagedb/prometheus	19.15% (ø)
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/conf	0.00% (ø)
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/conf_util	80.00% (ø)

---

Coverage by file

Changed files (no unit tests)

Changed File	Coverage Δ	Total	Covered	Missed	🤖
github.com/NVIDIA/KAI-scheduler/pkg/apis/kai/v1/schedulingshard_types.go	0.00% (ø)	5	0	5
github.com/NVIDIA/KAI-scheduler/pkg/apis/kai/v1/zz_generated.deepcopy.go	0.00% (ø)	265 (+7)	0	265 (+7)
github.com/NVIDIA/KAI-scheduler/pkg/env-tests/timeaware/timeaware.go	0.00% (ø)	150	0	150
github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/common/common.go	52.25% (ø)	111	58	53
github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/prometheus/resources.go	83.48% (+0.29%)	115 (+2)	96 (+2)	19	👍
github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/scheduler/resources_for_shard.go	86.54% (-1.22%)	104 (+6)	90 (+4)	14 (+2)	👎
github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/scheduler/scheduler.go	52.94% (ø)	34	18	16
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/cache.go	53.79% (ø)	132	71	61
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/usagedb/api/defaults.go	50.00% (-5.88%)	30 (-4)	15 (-4)	15	👎
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/usagedb/api/interface.go	13.51% (-86.49%)	37 (+32)	5	32 (+32)	💀 💀 💀 💀 💀
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/usagedb/fake/fake_with_history.go	0.00% (ø)	51	0	51
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/usagedb/prometheus/prometheus.go	19.15% (ø)	94	18	76
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/conf/scheduler_conf.go	0.00% (ø)	15	0	15
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/conf_util/scheduler_conf_util.go	80.00% (ø)	40	32	8

Please note that the "Total", "Covered", and "Missed" counts above refer to code statements instead of lines of code. The value in brackets refers to the test coverage of that file in the old version of the code.

Changed unit test files

• github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/prometheus/prometheus_test.go
• github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/scheduler/resources_test.go
• github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/scheduler/scheduler_test.go
• github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/usagedb/api/usage_params_test.go
• github.com/NVIDIA/KAI-scheduler/pkg/scheduler/conf_util/scheduler_conf_util_test.go

[github-actions]

Merging this branch changes the coverage (3 decrease, 1 increase)

Impacted Packages	Coverage Δ	🤖
github.com/NVIDIA/KAI-scheduler/pkg/apis/kai/v1	0.00% (ø)
github.com/NVIDIA/KAI-scheduler/pkg/env-tests/timeaware	0.00% (ø)
github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/common	52.25% (ø)
github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/known_types	13.06% (ø)
github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/prometheus	51.75% (+0.64%)	👍
github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/scheduler	78.32% (-0.51%)	👎
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache	35.14% (ø)
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/usagedb/api	29.85% (-31.69%)	💀 💀 💀
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/usagedb/fake	0.00% (ø)
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/usagedb/prometheus	18.18% (-0.97%)	👎
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/conf	0.00% (ø)
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/conf_util	80.00% (ø)

---

Coverage by file

Changed files (no unit tests)

Changed File	Coverage Δ	Total	Covered	Missed	🤖
github.com/NVIDIA/KAI-scheduler/pkg/apis/kai/v1/schedulingshard_types.go	0.00% (ø)	5	0	5
github.com/NVIDIA/KAI-scheduler/pkg/apis/kai/v1/zz_generated.deepcopy.go	0.00% (ø)	265 (+7)	0	265 (+7)
github.com/NVIDIA/KAI-scheduler/pkg/env-tests/timeaware/timeaware.go	0.00% (ø)	150	0	150
github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/common/common.go	52.25% (ø)	111	58	53
github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/known_types/prometheus.go	5.19% (ø)	77	4	73
github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/prometheus/resources.go	83.62% (+0.43%)	116 (+3)	97 (+3)	19	👍
github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/scheduler/resources_for_shard.go	86.54% (-1.22%)	104 (+6)	90 (+4)	14 (+2)	👎
github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/scheduler/scheduler.go	52.94% (ø)	34	18	16
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/cache.go	53.79% (ø)	132	71	61
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/usagedb/api/defaults.go	50.00% (-5.88%)	30 (-4)	15 (-4)	15	👎
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/usagedb/api/interface.go	13.51% (-86.49%)	37 (+32)	5	32 (+32)	💀 💀 💀 💀 💀
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/usagedb/fake/fake_with_history.go	0.00% (ø)	51	0	51
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/usagedb/prometheus/prometheus.go	18.18% (-0.97%)	99 (+5)	18	81 (+5)	👎
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/conf/scheduler_conf.go	0.00% (ø)	15	0	15
github.com/NVIDIA/KAI-scheduler/pkg/scheduler/conf_util/scheduler_conf_util.go	80.00% (ø)	40	32	8

Please note that the "Total", "Covered", and "Missed" counts above refer to code statements instead of lines of code. The value in brackets refers to the test coverage of that file in the old version of the code.

Changed unit test files

• github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/prometheus/prometheus_test.go
• github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/scheduler/resources_test.go
• github.com/NVIDIA/KAI-scheduler/pkg/operator/operands/scheduler/scheduler_test.go
• github.com/NVIDIA/KAI-scheduler/pkg/scheduler/cache/usagedb/api/usage_params_test.go
• github.com/NVIDIA/KAI-scheduler/pkg/scheduler/conf_util/scheduler_conf_util_test.go