This repository has been archived by the owner on Oct 16, 2023. It is now read-only.
README of Benchmark is not clear and misleading. #5
Labels
documentation
Improvements or additions to documentation
In 'Usage' part, the first command needs launchers, eg. OpenMPI, but this is not mentioned. It's easy to mislead newbies to waste time and effort if they are running on their local machine.
Some parameters in the second command seem not necessary, eg. I can run the example by the following command.
DATA=/data/cifar-10 torchrun --nproc_per_node=2 --master_port=29501 train.py --config=configs/vit_vanilla.py
In addition, it's hard for newbies to know what content they should provide for those parameters. eg. how to know the RANK, IP_ADDRESS and PORT. It would be better if you can provide some explanation and example.
The text was updated successfully, but these errors were encountered: