Merge pull request #112 from DSFans2014/fix/typo

fix: fix typos

Author: hami-robot[bot]

CHANGELOG.md

@@ -87,7 +87,7 @@
 - add ut for ascend by ([@shijinye](https://github.com/shijinye)) in [#664](https://github.com/Project-HAMi/HAMi/pull/664)
 - optimization map init in test by ([@lengrongfu](https://github.com/lengrongfu)) in [#678](https://github.com/Project-HAMi/HAMi/pull/678)
 - Optimize monitor by ([@for800000](https://github.com/for800000)) in [#683](https://github.com/Project-HAMi/HAMi/pull/683)
-- fix code lint faild by ([@lengrongfu](https://github.com/lengrongfu)) in [#685](https://github.com/Project-HAMi/HAMi/pull/685)
+- fix code lint failed by ([@lengrongfu](https://github.com/lengrongfu)) in [#685](https://github.com/Project-HAMi/HAMi/pull/685)
 - fix(helm): Add NODE_NAME env var to the vgpu-monitor container from spec.nodeName by ([@Nimbus318](https://github.com/Nimbus318)) in [#687](https://github.com/Project-HAMi/HAMi/pull/687)
 - fix vGPUmonitor deviceidx is always 0 by ([@lengrongfu](https://github.com/lengrongfu)) in [#684](https://github.com/Project-HAMi/HAMi/pull/684)
 - add ut for pkg/scheduler/event.go by ([@Penguin-zlh](https://github.com/Penguin-zlh)) in [#688](https://github.com/Project-HAMi/HAMi/pull/688)

blog/2024-12-31-post/index.md

@@ -1600,7 +1600,7 @@ type DevicePluginServer interface {
  // Plugin can run device specific operations and instruct Kubelet
  // of the steps to make the Device available in the container
  Allocate(context.Context, *AllocateRequest) (*AllocateResponse, error)
- // PreStartContainer is called, if indicated by Device Plugin during registeration phase,
+ // PreStartContainer is called, if indicated by Device Plugin during registration phase,
  // before each container start. Device plugin can run device specific operations
  // such as resetting the device before making devices available to the container
  PreStartContainer(context.Context, *PreStartContainerRequest) (*PreStartContainerResponse, error)
@@ -1678,7 +1678,7 @@ func (plugin *NvidiaDevicePlugin) WatchAndRegister() {
  errorSleepInterval := time.Second * 5
  successSleepInterval := time.Second * 30
  for {
-  err := plugin.RegistrInAnnotation()
+  err := plugin.RegisterInAnnotation()
   if err != nil {
    klog.Errorf("Failed to register annotation: %v", err)
    klog.Infof("Retrying in %v seconds...", errorSleepInterval)
@@ -1692,7 +1692,7 @@ func (plugin *NvidiaDevicePlugin) WatchAndRegister() {
 ```
 
 ```golang
-func (plugin *NvidiaDevicePlugin) RegistrInAnnotation() error {
+func (plugin *NvidiaDevicePlugin) RegisterInAnnotation() error {
  devices := plugin.getAPIDevices()
  klog.InfoS("start working on the devices", "devices", devices)
  annos := make(map[string]string)

changelog/source/v2.5.0.md

@@ -66,7 +66,7 @@ authors:
 - add ut for ascend by ([@shijinye](https://github.com/shijinye)) in [#664](https://github.com/Project-HAMi/HAMi/pull/664)
 - optimization map init in test by ([@lengrongfu](https://github.com/lengrongfu)) in [#678](https://github.com/Project-HAMi/HAMi/pull/678)
 - Optimize monitor by ([@for800000](https://github.com/for800000)) in [#683](https://github.com/Project-HAMi/HAMi/pull/683)
-- fix code lint faild by ([@lengrongfu](https://github.com/lengrongfu)) in [#685](https://github.com/Project-HAMi/HAMi/pull/685)
+- fix code lint failed by ([@lengrongfu](https://github.com/lengrongfu)) in [#685](https://github.com/Project-HAMi/HAMi/pull/685)
 - fix(helm): Add NODE_NAME env var to the vgpu-monitor container from spec.nodeName by ([@Nimbus318](https://github.com/Nimbus318)) in [#687](https://github.com/Project-HAMi/HAMi/pull/687)
 - fix vGPUmonitor deviceidx is always 0 by ([@lengrongfu](https://github.com/lengrongfu)) in [#684](https://github.com/Project-HAMi/HAMi/pull/684)
 - add ut for pkg/scheduler/event.go by ([@Penguin-zlh](https://github.com/Penguin-zlh)) in [#688](https://github.com/Project-HAMi/HAMi/pull/688)
@@ -160,4 +160,4 @@ authors:
 - phoenixwu0229 ([@phoenixwu0229](https://github.com/phoenixwu0229))
 - chinaran ([@chinaran](https://github.com/chinaran))
 
-**Full Changelog**: https://github.com/Project-HAMi/HAMi/compare/v2.4.1...v2.5.0
+**Full Changelog**: https://github.com/Project-HAMi/HAMi/compare/v2.4.1...v2.5.0

docs/contributor/contributers.md renamed to docs/contributor/contributors.md

@@ -1,5 +1,5 @@
 ---
-title: Goverance
+title: Governance
 ---
 
 Heterogeneous AI Computing Virtualization Middleware (HAMi), formerly known as k8s-vGPU-scheduler, is an "all-in-one" tools designed to manage Heterogeneous AI Computing Devices in a k8s cluster

docs/contributor/goverance.md renamed to docs/contributor/governance.md

@@ -1,5 +1,5 @@
 ---
-title: Contributer Ladder
+title: Contributor Ladder
 ---
 
 This docs different ways to get involved and level up within the project. You can see different roles within the project in the contributor roles.

docs/contributor/ladder.md

@@ -19,7 +19,7 @@ HAMi is done by using [hami-core](https://github.com/Project-HAMi/HAMi-core), wh
 - CPU, Mem, and GPU combined schedule
 - GPU dynamic slice: Hami-core and MIG
 - Support node-level binpack and spread by GPU memory, CPU and Mem
-- A unified vGPU Pool different virtualization technics
+- A unified vGPU Pool different virtualization techniques
 - Tasks can choose to use MIG, use HAMi-core, or use both.
 
 ### Config maps
@@ -104,7 +104,7 @@ data:
 
 ## Examples
 
-Dynamic mig is compatable with hami tasks, as the example below: 
+Dynamic mig is compatible with hami tasks, as the example below: 
 Just Setting `nvidia.com/gpu` and `nvidia.com/gpumem`.
 
 ```yaml
@@ -149,7 +149,7 @@ The Procedure of a vGPU task which uses dynamic-mig is shown below:
 
 <img src="https://github.com/Project-HAMi/HAMi/blob/master/docs/develop/imgs/hami-dynamic-mig-procedure.png?raw=true" width = "800" /> 
 
-Note that after submited a task, deviceshare plugin will iterate over templates defined in configMap `hami-scheduler-device`, and find the first available template to fit. You can always change the content of that configMap, and restart vc-scheduler to customize.
+Note that after submitted a task, deviceshare plugin will iterate over templates defined in configMap `hami-scheduler-device`, and find the first available template to fit. You can always change the content of that configMap, and restart vc-scheduler to customize.
 
 If you submit the example on an empty A100-PCIE-40GB node, then it will select a GPU and choose MIG template below:
 

docs/developers/Dynamic-mig.md

@@ -12,10 +12,10 @@ HAMi needs to know the spec of each AI devices in the cluster in order to schedu
 
 ```
 hami.io/node-handshake-\{device-type\}: Reported_\{device_node_current_timestamp\}
-hami.io/node-\{deivce-type\}-register: \{Device 1\}:\{Device2\}:...:\{Device N\}
+hami.io/node-\{device-type\}-register: \{Device 1\}:\{Device2\}:...:\{Device N\}
 ```
 
-The definiation of each device is in the following format:
+The definition of each device is in the following format:
 ```
 \{Device UUID\},\{device split count\},\{device memory limit\},\{device core limit\},\{device type\},\{device numa\},\{healthy\}
 ```

docs/developers/protocol.md

@@ -82,7 +82,7 @@ GPU spread, use different GPU cards when possible, egs:
 
 ### Node-scheduler-policy
 
-![node-shceduler-policy-demo.png](../resources/node-shceduler-policy-demo.png)
+![node-scheduler-policy-demo.png](../resources/node-scheduler-policy-demo.png)
 
 #### Binpack
 
@@ -166,4 +166,4 @@ GPU1 Score: ((20+10)/100 + (1000+2000)/8000)) * 10 = 6.75
 GPU2 Score: ((20+70)/100 + (1000+6000)/8000)) * 10 = 17.75
 ```
 
-So, in `Spread` policy we can select `GPU1`.
+So, in `Spread` policy we can select `GPU1`.

docs/developers/scheduling.md

@@ -160,7 +160,7 @@ spec:
           nvidia.com/gpumem: 10240 # Each vGPU contains 10240m device memory （Optional,Integer）
 ```
 
-#### 2. Verify in container resouce control {#verify-in-container-resouce-control}
+#### 2. Verify in container resource control {#verify-in-container-resource-control}
 
 Execute the following query command: