Skip to content

Commit 2e145f8

Browse files
authored
docs: fix typo in BackendGuide.md (#1039)
Signed-off-by: Shijie Ma <[email protected]>
1 parent e144e49 commit 2e145f8

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/BackendGuide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,16 +108,16 @@ Note that getNotif does not know which agent it should look for to receive the n
108108

109109
A key underlying abstraction for NIXL library is a descriptor list, that is made of a memory space (host/GPU/block/File/Obj-Store) and a list of descriptors. There are 2 types of descriptors used for the SB API.
110110

111-
*For transfers: (addr, len, devID, metadata), where metadata is a pointer to an nixlBackendMD object relevant to the registered memory that this descriptor falls within.
112-
*For registration, (addr, len, devID, str) where str is an optional byte-array for extra information. The table below shows the meaning of devID for different memory spaces, as well as optional meaning for File and Object-Store.
111+
* For transfers: (addr, len, devID, metadata), where metadata is a pointer to an nixlBackendMD object relevant to the registered memory that this descriptor falls within.
112+
* For registration, (addr, len, devID, str) where str is an optional byte-array for extra information. The table below shows the meaning of devID for different memory spaces, as well as optional meaning for File and Object-Store.
113113

114114
| mem type | addr | len | devID | str (byte-array) |
115115
| -------- | ------ | ---- | ------------- | -------------------------- |
116116
| DRAM | | | 0 (or region) | - |
117117
| VRAM | | | GPU ID | - |
118118
| BLK | | | Vol ID | - |
119119
| FILE | offset | Or 0 | fd | Path + (access mode) |
120-
| DRAM | offset | Or 0 | key | Extended key (+ bucket ID) |
120+
| OBJ | offset | Or 0 | key | Extended key (+ bucket ID) |
121121

122122
## Plugin Manager API
123123

@@ -165,7 +165,7 @@ In this step, if the plugin supports talking to remote agents, the required conn
165165

166166
When a connection is requested to an remote agent, which is possible if the remote agent’s metadata is already loaded, the local Agent would look for common backend plugins between itself and the remote agent, and for each of them initiate a connect by using the **connect** API in SB API of such backends.
167167

168-
### Register (Degister) memory with NIXL:
168+
### Register (Deregister) memory with NIXL:
169169

170170
The agent will receive a list of allocated memories and desired backend from the user, and then will give only one element at a time to the specified backend. Note that backends usually require to register the memories they will access during transfers, and based on that registration keep some metadata for that memory region. For instance, in case of UCX, per each contiguous region of memory, it will produce some local metadata for that region. Agent will give only a single contiguous region of memory to the **register** call in SB API, and in return gets a key (a pointer) to the metadata that backend created for this memory region. Later on, during transfer, the agent will give the same key back to the backend, so backends do not need to do any bookkeeping of such metadata.
171171

0 commit comments

Comments
 (0)