Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add atorch installation doc #765

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion atorch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,26 @@ TODO
TODO

## Installation
TODO

ATorch supports PyTorch with version >= 1.12, and verion 2.1 or above is preferred.
For example, docker image <code>easydl/atorch:iml_pt210</code> which has PyTorch 2.1 installed can be used.

Install atorch in any PyTorch-preinstalled environment (such as a container created with the docker image above) with <code>pip</code>:

```
pip install atorch
```

To verify that atorch is installed successfully, you run examples to see if succeed.

```
git clone https://github.com/intelligent-machine-learning/dlrover.git
cd dlrover/atorch/examples/auto_accelerate
# Single process train
python train.py --model_type toy
# Distributed train
python -m atorch.distributed.run --nproc_per_node 2 train.py --model_type llama --distributed --load_strategy --use_fsdp --use_amp --use_module_replace --use_checkpointing
```

## Contributing
TODO
Expand Down
2 changes: 1 addition & 1 deletion atorch/examples/auto_accelerate/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Running auto_accelerate Codes
# Running auto_accelerate Examples

## Source files

Expand Down
Loading