Skip to content
This repository was archived by the owner on Oct 16, 2023. It is now read-only.
This repository was archived by the owner on Oct 16, 2023. It is now read-only.

README of Benchmark is not clear and misleading. #5

@binmakeswell

Description

@binmakeswell

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions