[train] add FAQ #22757
[train] add FAQ #22757
Conversation
doc/source/train/user_guide.rst
Outdated
| @@ -1240,3 +1240,20 @@ Backwards Compatibility with Ray SGD | |||
| ------------------------------------ | |||
|
|
|||
| If you are currently using :ref:`RaySGD <sgd-index>`, you can migrate to Ray Train by following: :ref:`sgd-migration`. | |||
|
|
|||
| FAQ | |||
There was a problem hiding this comment.
@matthewdeng can we start an actual faq.rst page like Tune has? Please look at Tune for structure etc.
This is not necessarily true for Train, but a lot of our user guides are filled with minor FAQ-like sections.
There was a problem hiding this comment.
Yeah, certainly. I had originally decided against creating a separate page in this PR since I wasn't sure how the reader would react if there was just one question listed.
Are there any sections in the existing Train User Guide that you feel should be converted to FAQ? Or any other questions you think are worth answering to start it off?
There was a problem hiding this comment.
Lgtm, but will defer to @maxpumperla and @worldveil for final approval! Let me know when it's ready to merge!
|
@matthewdeng do you think this is ready to merge? Should we get another review from @maxpumperla or @worldveil? |
Adding a FAQ page. Currently has some basic questions that have come up in the past. Explaining how to use Matplotlib due to threading in the distributed training function.
Why are these changes needed?
Adding a FAQ page. Currently has some basic questions that have come up in the past.
Explaining how to use Matplotlib due to threading in the distributed training function.
Related issue number
Closes #22081
Checks
scripts/format.shto lint the changes in this PR.