Commit 6fbd0ae
authored
DOC: document missing parameters in load_accelerator_state, find_executable_batch_size, and send_to_device (#4051)
Three public API functions were missing parameters from their docstrings:
- load_accelerator_state(): dataloaders was a required parameter with no
documentation despite being present in the function signature.
- find_executable_batch_size(): reduce_batch_size_fn was undocumented.
It allows users to provide a custom batch size reduction strategy
instead of the default multiply-by-0.9 behavior.
- send_to_device(): non_blocking and skip_keys were both undocumented.
non_blocking enables async GPU transfers; skip_keys lets callers
exclude specific dict keys from device transfer.1 parent 4929d1e commit 6fbd0ae
3 files changed
Lines changed: 12 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
204 | 204 | | |
205 | 205 | | |
206 | 206 | | |
| 207 | + | |
| 208 | + | |
207 | 209 | | |
208 | 210 | | |
209 | 211 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
132 | 132 | | |
133 | 133 | | |
134 | 134 | | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
135 | 139 | | |
136 | 140 | | |
137 | 141 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
142 | 142 | | |
143 | 143 | | |
144 | 144 | | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
145 | 151 | | |
146 | 152 | | |
147 | 153 | | |
| |||
0 commit comments