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

[torchx/config] Generate docs on the available configuration options in .torchxconfig #375

Open
kiukchung opened this issue Jan 25, 2022 · 2 comments

Comments

@kiukchung
Copy link
Contributor

📚 Documentation

Note: not a request for correction of documentation!

Link

https://pytorch.org/torchx/latest/experimental/runner.config.html

What does it currently say?

Nothing wrong with the current docs, but would be nice to have a list of the options that are "set-able" via .torchxconfig

What should it say?

Add a section that lists out the possible options and section names. Note that some options (e.g. the types of schedulers available and their respective runopts) are different between Meta-internal and OSS. Having a contextual TorchXConfig DAO-like object with placeholders and generating a docs page by dumping that object would make it possible to capture these differences.

Why?

Currently it is not clear what options can/cannot be set via .torchxconfig, we need a glossary of all the available options along with a help string on what they do and default values (if any)

@kiukchung
Copy link
Contributor Author

FWIW this PR adds scheduler runoptions to each scheduler docs page by using SphinxDirective to query the runopts from the schedulers and generating the docs page. #374

@kiukchung kiukchung modified the milestone: 0.1.3 Release Jan 25, 2022
@d4l3k
Copy link
Member

d4l3k commented Apr 8, 2022

The documentation here has improved a fair amount, not sure if this is still a relevant issue https://pytorch.org/torchx/main/runner.config.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants