Skip to content

Commit

Permalink
Update README.md for adding links into examples
Browse files Browse the repository at this point in the history
Summary: Also add markdown style for the installation flow.

Reviewed By: chuanhaozhuge

Differential Revision: D67075979

fbshipit-source-id: 1c84268bc013dc9fb439b6ba3faadb42181e49e3
  • Loading branch information
tsunghsienlee authored and facebook-github-bot committed Dec 12, 2024
1 parent f9d2a8c commit a26c75e
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Optimizers is BSD licensed, as found in the LICENSE file.
## Installation and Dependencies
This code requires `python>=3.10` and `torch>=2.5.0`.
Install `distributed_shampoo` with all dependencies:
```
```bash
git clone [email protected]:facebookresearch/optimizers.git
cd optimizers
pip install .
Expand Down
6 changes: 3 additions & 3 deletions distributed_shampoo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,7 @@ optimizer = DistributedShampoo(
),
)
```
Please see `ddp_cifar10_example.py` as an example.
Please see [`ddp_cifar10_example.py`](https://github.com/facebookresearch/optimizers/blob/main/distributed_shampoo/examples/ddp_cifar10_example.py) as an example.

### FSDP Training Support

Expand Down Expand Up @@ -380,7 +380,7 @@ optimizer = DistributedShampoo(
),
)
```
Please see `fsdp_cifar10_example.py` as an example.
Please see [`fsdp_cifar10_example.py`](https://github.com/facebookresearch/optimizers/blob/main/distributed_shampoo/examples/fsdp_cifar10_example.py) as an example.

## Checkpointing Support

Expand Down Expand Up @@ -412,7 +412,7 @@ model.load_state_dict(state_dict["model"])
optimizer.load_distributed_state_dict(state_dict["optim"], key_to_param=model.named_parameters())
```

You can also refer to `ddp_cifar10_example.py` as an example.
You can also refer to [`ddp_cifar10_example.py`](https://github.com/facebookresearch/optimizers/blob/main/distributed_shampoo/examples/ddp_cifar10_example.py) as an example.

## Hyperparameter Tuning

Expand Down

0 comments on commit a26c75e

Please sign in to comment.