Skip to content

Commit

Permalink
[doc] typo fix and clarification (deepspeedai#563)
Browse files Browse the repository at this point in the history
This PR:
* fixes a misspelled method name
* also `( () )` doesn't read too well, until one reads the code and understands that it's not a formatting bug. I proposed to simply say that it's a callable object.
stas00 authored Nov 28, 2020

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
1 parent c51fa65 commit 17f36f1
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/_tutorials/getting-started.md
Original file line number Diff line number Diff line change
@@ -28,14 +28,14 @@ model_engine, optimizer, _, _ = deepspeed.initialize(args=cmd_args,
distributed data parallel or mixed precision training are done
appropriately under the hood. In addition to wrapping the model, DeepSpeed can
construct and manage the training optimizer, data loader, and the learning rate
scheduler based on the parameters passed to `deepspeed.initialze` and the
scheduler based on the parameters passed to `deepspeed.initialize` and the
DeepSpeed [configuration file](#deepspeed-configuration).


### Training

Once the DeepSpeed engine has been initialized, it can be used to train the
model using three simple APIs for forward propagation (`()`), backward
model using three simple APIs for forward propagation (callable object), backward
propagation (`backward`), and weight updates (`step`).

```python

0 comments on commit 17f36f1

Please sign in to comment.