Skip to content
This repository was archived by the owner on Nov 16, 2023. It is now read-only.

Commit dbcb0d1

Browse files
authored
Update doc links for HiveD (#54)
1 parent 40fb74d commit dbcb0d1

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ A Framework represents an application with a set of Tasks:
5757
5. Support to specify how to [classify and summarize Pod failures](doc/user-manual.md#PodFailureClassification)
5858
6. Support to expose [Framework and Pod history snapshots](doc/user-manual.md#FrameworkPodHistory) to external systems
5959
7. Easy to leverage [FrameworkBarrier](doc/user-manual.md#FrameworkBarrier) to achieve light-weight Gang Execution and Service Discovery
60-
8. Easy to leverage [HivedScheduler](doc/user-manual.md#HivedScheduler) to achieve GPU Topology-Aware, Multi-Tenant, Priority and Gang Scheduling
60+
8. Easy to leverage [HiveDScheduler](doc/user-manual.md#HiveDScheduler) to achieve GPU Topology-Aware, Multi-Tenant, Priority and Gang Scheduling
6161
9. Compatible with other Kubernetes features, such as Kubernetes [Service](https://kubernetes.io/docs/concepts/services-networking/service), [Gpu Scheduling](https://kubernetes.io/docs/tasks/manage-gpus/scheduling-gpus), [Volume](https://kubernetes.io/docs/concepts/storage/volumes/), [Logging](https://kubernetes.io/docs/concepts/cluster-administration/logging)
6262
10. Idiomatic with Kubernetes official controllers, such as [Pod Spec](https://kubernetes.io/docs/concepts/workloads/pods/pod-overview/#pod-templates)
6363
11. Aligned with Kubernetes [Controller Design Guidelines](https://github.com/kubernetes/community/blob/f0dd87ad477e1e91c53866902adf7832c32ce543/contributors/devel/sig-api-machinery/controllers.md) and [API Conventions](https://github.com/kubernetes/community/blob/a2cdce51a0bbbc214f0e8813e0a877176ad3b6c9/contributors/devel/sig-architecture/api-conventions.md)
@@ -87,7 +87,7 @@ A specialized wrapper can be built on top of FrameworkController to optimize for
8787
### Recommended Kubernetes Scheduler
8888
FrameworkController can directly leverage many [Kubernetes Schedulers](https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers) and among them we recommend these best fits:
8989
* [Kubernetes Default Scheduler](https://kubernetes.io/docs/concepts/scheduling/kube-scheduler/#kube-scheduler): A General-Purpose Kubernetes Scheduler
90-
* [HivedScheduler](doc/user-manual.md#HivedScheduler): A Kubernetes Scheduler Extender optimized for GPUs
90+
* [HiveDScheduler](doc/user-manual.md#HiveDScheduler): A Kubernetes Scheduler Extender optimized for AI applications
9191

9292
### Similar Offering On Other Cluster Manager
9393
* [YARN FrameworkLauncher](https://github.com/microsoft/pai/blob/master/subprojects/frameworklauncher/yarn): Similar offering natively supports [Apache YARN](http://hadoop.apache.org)

doc/user-manual.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
- [Framework Consistency vs Availability](#FrameworkConsistencyAvailability)
1515
- [Controller Extension](#ControllerExtension)
1616
- [FrameworkBarrier](#FrameworkBarrier)
17-
- [HivedScheduler](#HivedScheduler)
17+
- [HiveDScheduler](#HiveDScheduler)
1818
- [Best Practice](#BestPractice)
1919

2020
## <a name="FrameworkInterop">Framework Interop</a>
@@ -464,9 +464,9 @@ See more in:
464464
1. [Usage](../pkg/barrier/barrier.go)
465465
2. Example: [FrameworkBarrier Example](../example/framework/extension/frameworkbarrier.yaml), [TensorFlow Example](../example/framework/scenario/tensorflow), [etc](../example/framework/scenario).
466466

467-
### <a name="HivedScheduler">HivedScheduler</a>
468-
1. [Usage](https://github.com/microsoft/pai/tree/master/subprojects/hivedscheduler)
469-
2. Example: [TensorFlow Example](../example/framework/scenario/tensorflow/gpu/tensorflowdistributedtrainingwithhivedscheduledgpu.yaml), [etc](https://github.com/microsoft/pai/blob/master/subprojects/GOPATH/src/github.com/microsoft/hivedscheduler/example/request/design/request.yaml).
467+
### <a name="HiveDScheduler">HiveDScheduler</a>
468+
1. [Usage](https://github.com/microsoft/hivedscheduler)
469+
2. Example: [TensorFlow Example](../example/framework/scenario/tensorflow/gpu/tensorflowdistributedtrainingwithhivedscheduledgpu.yaml), [etc](https://github.com/microsoft/hivedscheduler/example/request/design/request.yaml).
470470

471471
## <a name="BestPractice">Best Practice</a>
472472
[Best Practice](../pkg/apis/frameworkcontroller/v1/types.go)

example/framework/scenario/tensorflow/gpu/tensorflowdistributedtrainingwithhivedscheduledgpu.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ spec:
3434
affinityGroup: null
3535
spec:
3636
# [PREREQUISITE]
37-
# Do not specify the schedulerName if the HivedScheduler is directly
37+
# Do not specify the schedulerName if the HiveDScheduler is directly
3838
# called by the k8s default scheduler.
3939
schedulerName: hivedscheduler
4040
restartPolicy: Never
@@ -76,8 +76,8 @@ spec:
7676
resources:
7777
limits:
7878
# [PREREQUISITE]
79-
# User needs to setup HivedScheduler for the k8s cluster.
80-
# See https://github.com/microsoft/pai/tree/master/subprojects/hivedscheduler
79+
# User needs to setup HiveDScheduler for the k8s cluster.
80+
# See https://github.com/microsoft/hivedscheduler
8181
hivedscheduler.microsoft.com/pod-scheduling-enable: 1
8282
cpu: 3
8383
memory: 96Gi

0 commit comments

Comments
 (0)