transformers icon indicating copy to clipboard operation
transformers copied to clipboard

added doctring to SchedulerType class

Open Arunprakash-A opened this issue 6 months ago • 5 comments

What does this PR do?

It adds the docstring for the class SchedulerType . Currently, the AutoDoc only displays the __call__ signature of enum.EnumType base class which is not helpful. One needs to look for the names and the respective mapping in the source code of trainer.py. Therefore, added the docstring that lists out all the available names and the scheduler types they are mapped to.

Before submitting

  • [x] This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • [x] Did you read the contributor guideline, Pull Request section?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag members/contributors who may be interested in your PR.

Documentation: @stevhliu

Arunprakash-A avatar Aug 20 '24 10:08 Arunprakash-A