resource_share

package

v0.7.13 Latest Latest Go to latest Published: Aug 12, 2025 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/NVIDIA/KAI-scheduler

Links

Documentation ¶

Index ¶

Variables
type QueueAttributes
- func (q *QueueAttributes) Clone() *QueueAttributes
- func (q *QueueAttributes) IsTopQueue() bool
type QueueOverrides
- func (qo *QueueOverrides) ToQueueAttributes() *QueueAttributes
type QueueResourceShare
type QueueResourceShareOverrides
- func (q QueueResourceShareOverrides) ResourceShare() QueueResourceShare
type ResourceName
type ResourceQuantities
- func EmptyResourceQuantities() ResourceQuantities
- func NewResourceQuantities(cpuQty, memoryQty, gpuQty float64) ResourceQuantities
type ResourceShare
- func EmptyResource() ResourceShare
type ResourceShareOverrides
- func (r *ResourceShareOverrides) ResourceShare() *ResourceShare

Constants ¶

This section is empty.

Variables ¶

View Source

var AllResources = []ResourceName{CpuResource, MemoryResource, GpuResource}

Functions ¶

This section is empty.

Types ¶

type QueueAttributes ¶

type QueueAttributes struct {
	UID               common_info.QueueID
	Name              string
	ParentQueue       common_info.QueueID
	ChildQueues       []common_info.QueueID
	CreationTimestamp metav1.Time
	Priority          int
	QueueResourceShare
}

func (*QueueAttributes) Clone ¶

func (q *QueueAttributes) Clone() *QueueAttributes

func (*QueueAttributes) IsTopQueue ¶

func (q *QueueAttributes) IsTopQueue() bool

type QueueOverrides ¶ added in v0.7.11

type QueueOverrides struct {
	UID               common_info.QueueID         `json:"uid"`
	Name              string                      `json:"name"`
	ParentQueue       common_info.QueueID         `json:"parentQueue"`
	ChildQueues       []common_info.QueueID       `json:"childQueues"`
	CreationTimestamp *string                     `json:"creationTimestamp"`
	Priority          *int                        `json:"priority"`
	ResourceShare     QueueResourceShareOverrides `json:"resourceShare"`
}

func (*QueueOverrides) ToQueueAttributes ¶ added in v0.7.11

func (qo *QueueOverrides) ToQueueAttributes() *QueueAttributes

type QueueResourceShare ¶

type QueueResourceShare struct {
	CPU    ResourceShare
	Memory ResourceShare
	GPU    ResourceShare
	// contains filtered or unexported fields
}

func (*QueueResourceShare) AddResourceShare ¶

func (qrs *QueueResourceShare) AddResourceShare(resource ResourceName, amount float64)

func (*QueueResourceShare) GetAllocatableShare ¶

func (qrs *QueueResourceShare) GetAllocatableShare() ResourceQuantities

func (*QueueResourceShare) GetAllocatedNonPreemptible ¶

func (qrs *QueueResourceShare) GetAllocatedNonPreemptible() ResourceQuantities

func (*QueueResourceShare) GetAllocatedShare ¶

func (qrs *QueueResourceShare) GetAllocatedShare() ResourceQuantities

func (*QueueResourceShare) GetDeservedShare ¶

func (qrs *QueueResourceShare) GetDeservedShare() ResourceQuantities

func (*QueueResourceShare) GetDominantResourceShare ¶

func (qrs *QueueResourceShare) GetDominantResourceShare(totalResources ResourceQuantities) float64

func (*QueueResourceShare) GetFairShare ¶

func (qrs *QueueResourceShare) GetFairShare() ResourceQuantities

func (*QueueResourceShare) GetMaxAllowedShare ¶

func (qrs *QueueResourceShare) GetMaxAllowedShare() ResourceQuantities

func (*QueueResourceShare) GetRequestShare ¶

func (qrs *QueueResourceShare) GetRequestShare() ResourceQuantities

func (*QueueResourceShare) GetRequestableShare ¶

func (qrs *QueueResourceShare) GetRequestableShare() ResourceQuantities

func (*QueueResourceShare) ResourceShare ¶

func (qrs *QueueResourceShare) ResourceShare(resource ResourceName) *ResourceShare

func (*QueueResourceShare) SetQuotaResources ¶

func (qrs *QueueResourceShare) SetQuotaResources(resource ResourceName, deserved float64, maxAllowed float64,
	overQuotaWeight float64)

type QueueResourceShareOverrides ¶ added in v0.7.11

type QueueResourceShareOverrides struct {
	GPU    *ResourceShareOverrides `json:"gpu"`
	CPU    *ResourceShareOverrides `json:"cpu"`
	Memory *ResourceShareOverrides `json:"memory"`
}

func (QueueResourceShareOverrides) ResourceShare ¶ added in v0.7.11

func (q QueueResourceShareOverrides) ResourceShare() QueueResourceShare

type ResourceName ¶

type ResourceName string

const (
	CpuResource    ResourceName = "CPU"
	MemoryResource ResourceName = "Memory"
	GpuResource    ResourceName = "GPU"
)

type ResourceQuantities ¶

type ResourceQuantities map[ResourceName]float64

func EmptyResourceQuantities ¶

func EmptyResourceQuantities() ResourceQuantities

func NewResourceQuantities ¶

func NewResourceQuantities(cpuQty, memoryQty, gpuQty float64) ResourceQuantities

func (ResourceQuantities) Add ¶

func (rq ResourceQuantities) Add(other ResourceQuantities)

func (ResourceQuantities) Clone ¶

func (rq ResourceQuantities) Clone() ResourceQuantities

func (ResourceQuantities) Less ¶

func (rq ResourceQuantities) Less(other ResourceQuantities) bool

func (ResourceQuantities) LessEqual ¶

func (rq ResourceQuantities) LessEqual(other ResourceQuantities) bool

func (ResourceQuantities) LessInAtLeastOneResource ¶

func (rq ResourceQuantities) LessInAtLeastOneResource(other ResourceQuantities) bool

func (ResourceQuantities) String ¶

func (rq ResourceQuantities) String() string

func (ResourceQuantities) Sub ¶

func (rq ResourceQuantities) Sub(other ResourceQuantities)

type ResourceShare ¶

type ResourceShare struct {
	Deserved                float64
	FairShare               float64
	MaxAllowed              float64
	OverQuotaWeight         float64
	Allocated               float64
	AllocatedNotPreemptible float64
	Request                 float64
}

func EmptyResource ¶

func EmptyResource() ResourceShare

func (*ResourceShare) Clone ¶

func (rs *ResourceShare) Clone() *ResourceShare

func (*ResourceShare) GetAllocatableShare ¶

func (rs *ResourceShare) GetAllocatableShare() float64

func (*ResourceShare) GetRequestShare ¶

func (rs *ResourceShare) GetRequestShare() float64

func (*ResourceShare) GetRequestableShare ¶

func (rs *ResourceShare) GetRequestableShare() float64

type ResourceShareOverrides ¶ added in v0.7.11

type ResourceShareOverrides struct {
	Deserved                *float64 `json:"deserved"`
	FairShare               *float64 `json:"fairShare"`
	MaxAllowed              *float64 `json:"maxAllowed"`
	OverQuotaWeight         *float64 `json:"overQuotaWeight"`
	Allocated               *float64 `json:"allocated"`
	AllocatedNotPreemptible *float64 `json:"allocatedNotPreemptible"`
	Request                 *float64 `json:"request"`
	AbsoluteUsage           *float64 `json:"absoluteUsage"`
	VacantAdjustedUsage     *float64 `json:"vacantAdjustedUsage"`
}

func (*ResourceShareOverrides) ResourceShare ¶ added in v0.7.11

func (r *ResourceShareOverrides) ResourceShare() *ResourceShare

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL